DocumentTypeCustomRuleMatcher (Oxygen XML API)

All Superinterfaces:

Extension

All Known Implementing Classes:

DITACustomRuleMatcher, DITAMap2_xCustomRuleMatcher, DITAMapCustomRuleMatcher, DITAMapResolvedReferencesCustomRuleMatcher, DITATopic2_xCustomRuleMatcher, DITATopicCustomRuleMatcher, DocumentTypeAdvancedCustomRuleMatcher, HTML5CustomRuleMatcher, JSONAndYAMLPropertiesRuleMatcherBase, JSONAndYAMLRuleMatcherBase, WebAuthorPlatformCustomRuleMatcher
```
@API(type=EXTENDABLE,
     src=PUBLIC)
public interface DocumentTypeCustomRuleMatcher
extends Extension
```
Interface which can be implemented to provide custom matching to the document type it belongs to.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`matches(java.lang.String systemID, java.lang.String rootNamespace, java.lang.String rootLocalName, java.lang.String doctypePublicID, org.xml.sax.Attributes rootAttributes)`	Check if the document type to which this custom rule belongs to should be used for the given document properties.

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

- Method Detail
  - matches
```
boolean matches(java.lang.String systemID,
                java.lang.String rootNamespace,
                java.lang.String rootLocalName,
                java.lang.String doctypePublicID,
                org.xml.sax.Attributes rootAttributes)
```
    Check if the document type to which this custom rule belongs to should be used for the given document properties.
    
    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.
    
    Returns:
    
    true if the document type to which this rule belongs to will be used for the current file.