Package ro.sync.json

Class JSONAndYAMLRuleMatcherBase

java.lang.Object

ro.sync.ecss.extensions.api.DocumentTypeAdvancedCustomRuleMatcher

ro.sync.json.JSONAndYAMLRuleMatcherBase

All Implemented Interfaces:

DocumentTypeCustomRuleMatcher, Extension

@API(type=EXTENDABLE,
     src=PRIVATE)
public abstract class JSONAndYAMLRuleMatcherBase
extends DocumentTypeAdvancedCustomRuleMatcher

OpenAPI base matcher.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JSONAndYAMLRuleMatcherBase(String tagName, String[] versions)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	matches(String systemID, String rootNamespace, String rootLocalName, String doctypePublicID, Attributes rootAttributes, Reader contentReader)	Check if the document type to which this custom rule belongs to should be used for the given document properties.

Methods inherited from class ro.sync.ecss.extensions.api.DocumentTypeAdvancedCustomRuleMatcher

matches, matches

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ro.sync.ecss.extensions.api.Extension

getDescription

Constructor Details

JSONAndYAMLRuleMatcherBase

protected JSONAndYAMLRuleMatcherBase(String tagName,
 String[] versions)

Constructor

Parameters:

tagName - The tag name to check.

versions - The expected versions.

Method Details

matches

public boolean matches(String systemID,
 String rootNamespace,
 String rootLocalName,
 String doctypePublicID,
 Attributes rootAttributes,
 Reader contentReader)

Description copied from class: DocumentTypeAdvancedCustomRuleMatcher

Check if the document type to which this custom rule belongs to should be used for the given document properties. This method receives a reader over the entire content.

Overrides:

matches in class DocumentTypeAdvancedCustomRuleMatcher

Parameters:

systemID - The system ID of the current file in an URL format with not allowed characters corrected. For example: "file:/C:/path/to/file/file.xml"

rootNamespace - The namespace of the root.

rootLocalName - The root local name.

doctypePublicID - The public id of the specified DTD if any.

rootAttributes - The root attributes. The attributes are DOM level 2 and the namespaces are available for each one.

contentReader - Reader over the entire XML content. Can be used for detection if all other parameters are not enough. The reader does not need to be reset or closed. It may be null.

Returns:

true if the document type to which this rule belongs to will be used for the current file.

See Also:

• DocumentTypeAdvancedCustomRuleMatcher.matches(java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes, java.io.Reader)