org.eclipse.lemminx.extensions.contentmodel.model

Interface CMAttributeDeclaration

All Known Implementing Classes:

CMDTDAttributeDeclaration, CMXSDAttributeDeclaration

public interface CMAttributeDeclaration

Content model element which abstracts attribute declaration from a given grammar (XML Schema, DTD).

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()
Collection<String>	getEnumerationValues()
String	getName() Returns the declared element name.
default String	getName(String prefix) Returns the declared attribute name with the given prefix.
String	getNamespace() Returns the target namespace and null otherwise.
boolean	isRequired() Returns true if the attribute is required and false otherwise.

Method Detail

getName

String getName()

Returns the declared element name.

Returns:

the declared element name.

getNamespace

String getNamespace()

Returns the target namespace and null otherwise.

Returns:

the target namespace and null otherwise.

getName

default String getName(String prefix)

Returns the declared attribute name with the given prefix.

Returns:

the declared attribute name with the given prefix.

getDefaultValue

String getDefaultValue()

getEnumerationValues

Collection<String> getEnumerationValues()

getAttributeNameDocumentation

String getAttributeNameDocumentation(ISharedSettingsRequest request)

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

Parameters:

request - the request that contains settings

Returns:

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

getAttributeValueDocumentation

String getAttributeValueDocumentation(String value,
                                      ISharedSettingsRequest request)

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

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

boolean isRequired()

Returns true if the attribute is required and false otherwise.

Returns:

true if the attribute is required and false otherwise.