Package ro.sync.ecss.extensions.api.node
Interface AuthorDocument
-
- All Superinterfaces:
AuthorNode
,AuthorParentNode
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorDocument extends AuthorParentNode
The Document interface represents the entire XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
-
-
Field Summary
-
Fields inherited from interface ro.sync.ecss.extensions.api.node.AuthorNode
NODE_NAME_CDATA, NODE_NAME_COMMENT, NODE_NAME_DOCUMENT, NODE_NAME_PI, NODE_NAME_REFERENCE, NODE_TYPE_CDATA, NODE_TYPE_COMMENT, NODE_TYPE_DOCUMENT, NODE_TYPE_ELEMENT, NODE_TYPE_PI, NODE_TYPE_PSEUDO_DOCTYPE, NODE_TYPE_PSEUDO_ELEMENT, NODE_TYPE_REFERENCE, NODE_TYPE_TEXT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AuthorElementBaseInterface
getElementById(java.lang.String id)
Gets the element that has the ID attribute with the specified value.int
getLength()
Get the length of the document.AuthorElement
getRootElement()
Returns the child node that is the root element of the document.java.lang.String
getSystemID()
Returns the systemID of the document.-
Methods inherited from interface ro.sync.ecss.extensions.api.node.AuthorNode
getContentIterator, getDisplayName, getEndOffset, getName, getNamespace, getNamespaceContext, getOwnerDocument, getParent, getStartOffset, getTextContent, getType, getXMLBaseURL, isDescendentOf
-
Methods inherited from interface ro.sync.ecss.extensions.api.node.AuthorParentNode
getContentNodes, getParentElement
-
-
-
-
Method Detail
-
getRootElement
AuthorElement getRootElement()
Returns the child node that is the root element of the document.- Returns:
- The root element of the document. Might be
null
for documents with no children elements.
-
getSystemID
java.lang.String getSystemID()
Returns the systemID of the document.- Returns:
- The systemID of the document, or
null
if not provided.
-
getLength
int getLength()
Get the length of the document.- Returns:
- the length of the document in characters, including the sentinel characters that delimit each element.
- Since:
- 13.2
-
getElementById
AuthorElementBaseInterface getElementById(java.lang.String id)
Gets the element that has the ID attribute with the specified value.- Parameters:
id
- The ID of the searched element. Should not contain the # symbol.- Returns:
null
if no elements with the specified ID exists.
-
-