org.eclipse.lemminx.extensions.xsd.contentmodel

Class CMXSDElementDeclaration

java.lang.Object

org.eclipse.lemminx.extensions.xsd.contentmodel.CMXSDElementDeclaration

All Implemented Interfaces:

CMElementDeclaration

public class CMXSDElementDeclaration
extends Object
implements CMElementDeclaration

XSD element declaration implementation.

Field Summary

Fields inherited from interface org.eclipse.lemminx.extensions.contentmodel.model.CMElementDeclaration

ANY_ELEMENT_DECLARATIONS

Constructor Summary

Constructors

Constructor and Description
CMXSDElementDeclaration(CMXSDDocument document, org.apache.xerces.xs.XSElementDeclaration elementDeclaration)

Method Summary

Modifier and Type	Method and Description
CMAttributeDeclaration	findCMAttribute(String attributeName) Returns the declared attribute which match the given name and null otherwise.
CMElementDeclaration	findCMElement(String tag, String namespace) Returns the declared element which matches the given XML tag name / namespace and null otherwise.
Collection<CMAttributeDeclaration>	getAttributes() Returns the attributes of this declared element.
String	getDocumentation(ISharedSettingsRequest request) Returns formatted documentation of the declared element, according to settings defined in request.
String	getDocumentURI() Returns the owner document URI where the element is declared.
Collection<CMElementDeclaration>	getElements() Returns the children declared element of this declared element.
Collection<String>	getEnumerationValues() Return the enumeration values.
String	getName() Returns the declared element name.
String	getNamespace() Returns the target namespace and null otherwise.
Collection<CMElementDeclaration>	getPossibleElements(DOMElement parentElement, int offset) Returns the possible declared elements at the given offset of the given parent element.
String	getTextDocumentation(String textContent, ISharedSettingsRequest request) Returns the documentation for the given enumeration value and null otherwise.
boolean	isEmpty() Returns true if the element cannot contains element children or text content 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.CMElementDeclaration

getName

Constructor Detail

CMXSDElementDeclaration

public CMXSDElementDeclaration(CMXSDDocument document,
                               org.apache.xerces.xs.XSElementDeclaration elementDeclaration)

Method Detail

getName

public String getName()

Description copied from interface: CMElementDeclaration

Returns the declared element name.

Specified by:

getName in interface CMElementDeclaration

Returns:

the declared element name.

getNamespace

public String getNamespace()

Description copied from interface: CMElementDeclaration

Returns the target namespace and null otherwise.

Specified by:

getNamespace in interface CMElementDeclaration

Returns:

the target namespace and null otherwise.

getAttributes

public Collection<CMAttributeDeclaration> getAttributes()

Description copied from interface: CMElementDeclaration

Returns the attributes of this declared element.

Specified by:

getAttributes in interface CMElementDeclaration

Returns:

the attributes element of this declared element.

getElements

public Collection<CMElementDeclaration> getElements()

Description copied from interface: CMElementDeclaration

Returns the children declared element of this declared element.

Specified by:

getElements in interface CMElementDeclaration

Returns:

the children declared element of this declared element.

getPossibleElements

public Collection<CMElementDeclaration> getPossibleElements(DOMElement parentElement,
                                                            int offset)

Description copied from interface: CMElementDeclaration

Returns the possible declared elements at the given offset of the given parent element.

Specified by:

getPossibleElements in interface CMElementDeclaration

Parameters:

parentElement - the parent element

offset - the offset

Returns:

the possible declared elements at the given offset of the given parent element.

getDocumentation

public String getDocumentation(ISharedSettingsRequest request)

Description copied from interface: CMElementDeclaration

Returns formatted documentation of the declared element, according to settings defined in request.

Specified by:

getDocumentation in interface CMElementDeclaration

Parameters:

request - the request containing settings

Returns:

formatted documentation of the declared element, according to settings defined in request.

findCMElement

public CMElementDeclaration findCMElement(String tag,
                                          String namespace)

Description copied from interface: CMElementDeclaration

Returns the declared element which matches the given XML tag name / namespace and null otherwise.

Specified by:

findCMElement in interface CMElementDeclaration

Returns:

the declared element which matches the given XML tag name / namespace and null otherwise.

findCMAttribute

public CMAttributeDeclaration findCMAttribute(String attributeName)

Description copied from interface: CMElementDeclaration

Returns the declared attribute which match the given name and null otherwise.

Specified by:

findCMAttribute in interface CMElementDeclaration

Returns:

the declared attribute which match the given name and null otherwise.

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Description copied from interface: CMElementDeclaration

Returns true if the element cannot contains element children or text content and false otherwise.

Specified by:

isEmpty in interface CMElementDeclaration

Returns:

true if the element cannot contains element children or text content and false otherwise.

getEnumerationValues

public Collection<String> getEnumerationValues()

Description copied from interface: CMElementDeclaration

Return the enumeration values.

Specified by:

getEnumerationValues in interface CMElementDeclaration

Returns:

the enumeration values.

getTextDocumentation

public String getTextDocumentation(String textContent,
                                   ISharedSettingsRequest request)

Description copied from interface: CMElementDeclaration

Returns the documentation for the given enumeration value and null otherwise.

Specified by:

getTextDocumentation in interface CMElementDeclaration

Parameters:

textContent - the enumeration value.

request - the shared settings.

Returns:

the documentation for the given enumeration value and null otherwise.

getDocumentURI

public String getDocumentURI()

Description copied from interface: CMElementDeclaration

Returns the owner document URI where the element is declared.

Specified by:

getDocumentURI in interface CMElementDeclaration

Returns:

the owner document URI where the element is declared.