com.thaiopensource.relaxng.pattern

Class CMRelaxNGAttributeDeclaration

java.lang.Object

com.thaiopensource.relaxng.pattern.CMRelaxNGAttributeDeclaration

All Implemented Interfaces:

CMAttributeDeclaration

public class CMRelaxNGAttributeDeclaration
extends Object
implements CMAttributeDeclaration

RelaxNG content attribute implementation.

NOTE : this class is hosted in 'com.thaiopensource.relaxng.pattern' because Pattern implementation like ElementPattern are not public. Once https://github.com/relaxng/jing-trang/issues/271 will be fixed we could move this class in 'org.eclipse.lemminx.extensions.relaxng.contentmodel' package.

Author:

Angelo ZERR

Constructor Summary

Constructors

Constructor and Description
CMRelaxNGAttributeDeclaration(CMRelaxNGElementDeclaration element, com.thaiopensource.relaxng.pattern.AttributePattern pattern)

Method Summary

Modifier and Type	Method and Description
String	getAttributeNameDocumentation(ISharedSettingsRequest request) Returns formatted documentation of the declared attribute according to settings defined in request
String	getAttributeValueDocumentation(String value, ISharedSettingsRequest request) Returns formatted documentation about value, according to settings defined in request
String	getDefaultValue() Returns the default value of the declared attribute and null otherwise.
Collection<String>	getEnumerationValues() Returns enumeration values of the declared attribute and empty collection otherwise.
String	getLocalName() Returns the declared attribute local name.
String	getNamespace() Returns the target namespace and null otherwise.
CMElementDeclaration	getOwnerElementDeclaration() Returns the owner element declaration.
com.thaiopensource.relaxng.pattern.AttributePattern	getPattern()
boolean	isRequired() Returns true if the attribute is required and false otherwise.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.lemminx.extensions.contentmodel.model.CMAttributeDeclaration

getName, getName

Constructor Detail

CMRelaxNGAttributeDeclaration

public CMRelaxNGAttributeDeclaration(CMRelaxNGElementDeclaration element,
                                     com.thaiopensource.relaxng.pattern.AttributePattern pattern)

Method Detail

getLocalName

public String getLocalName()

Description copied from interface: CMAttributeDeclaration

Returns the declared attribute local name.

Specified by:

getLocalName in interface CMAttributeDeclaration

Returns:

the declared attribute local name.

getNamespace

public String getNamespace()

Description copied from interface: CMAttributeDeclaration

Returns the target namespace and null otherwise.

Specified by:

getNamespace in interface CMAttributeDeclaration

Returns:

the target namespace and null otherwise.

getOwnerElementDeclaration

public CMElementDeclaration getOwnerElementDeclaration()

Description copied from interface: CMAttributeDeclaration

Returns the owner element declaration.

Specified by:

getOwnerElementDeclaration in interface CMAttributeDeclaration

Returns:

the owner element declaration.

getDefaultValue

public String getDefaultValue()

Description copied from interface: CMAttributeDeclaration

Returns the default value of the declared attribute and null otherwise.

Specified by:

getDefaultValue in interface CMAttributeDeclaration

Returns:

the default value of the declared attribute and null otherwise.

getEnumerationValues

public Collection<String> getEnumerationValues()

Description copied from interface: CMAttributeDeclaration

Returns enumeration values of the declared attribute and empty collection otherwise.

Specified by:

getEnumerationValues in interface CMAttributeDeclaration

Returns:

enumeration values of the declared attribute and empty collection otherwise.

getAttributeNameDocumentation

public String getAttributeNameDocumentation(ISharedSettingsRequest request)

Description copied from interface: CMAttributeDeclaration

Returns formatted documentation of the declared attribute according to settings defined in request

Specified by:

getAttributeNameDocumentation in interface CMAttributeDeclaration

Parameters:

request - the request that contains settings

Returns:

formatted documentation of the declared attribute according to settings defined in request

getAttributeValueDocumentation

public String getAttributeValueDocumentation(String value,
                                             ISharedSettingsRequest request)

Description copied from interface: CMAttributeDeclaration

Returns formatted documentation about value, according to settings defined in request

Specified by:

getAttributeValueDocumentation in interface CMAttributeDeclaration

Parameters:

value - the attribute value to find documentation for

request - the request containing settings

Returns:

formatted documentation about value, according to settings defined in request

isRequired

public boolean isRequired()

Description copied from interface: CMAttributeDeclaration

Returns true if the attribute is required and false otherwise.

Specified by:

isRequired in interface CMAttributeDeclaration

Returns:

true if the attribute is required and false otherwise.

getPattern

public com.thaiopensource.relaxng.pattern.AttributePattern getPattern()

toString

public String toString()

Overrides:

toString in class Object