org.xmlpull.v1.builder
Interface XmlDocument

All Superinterfaces:

java.lang.Cloneable, XmlContainer

All Known Implementing Classes:

XmlDocumentAdapter, XmlDocumentImpl

public interface XmlDocument
extends XmlContainer, java.lang.Cloneable

Represents Document Information Item .

Method Summary

void	addChild(java.lang.Object child)
XmlComment	addComment(java.lang.String content)
XmlDoctype	addDoctype(java.lang.String systemIdentifier, java.lang.String publicIdentifier)
XmlElement	addDocumentElement(java.lang.String name)
XmlElement	addDocumentElement(XmlNamespace namespace, java.lang.String name)
XmlNotation	addNotation(java.lang.String name, java.lang.String systemIdentifier, java.lang.String publicIdentifier, java.lang.String declarationBaseUri)
XmlProcessingInstruction	addProcessingInstruction(java.lang.String target, java.lang.String content)
Iterable	children() An ordered list of child information items, in document order.
java.lang.Object	clone()
XmlElement	element(XmlNamespace n, java.lang.String name)
XmlElement	element(XmlNamespace n, java.lang.String name, boolean create)
java.lang.String	getBaseUri()
java.lang.String	getCharacterEncodingScheme()
XmlElement	getDocumentElement()
java.lang.String	getVersion()
void	insertChild(int pos, java.lang.Object child)
boolean	isAllDeclarationsProcessed()
java.lang.Boolean	isStandalone()
XmlComment	newComment(java.lang.String content)
XmlDoctype	newDoctype(java.lang.String systemIdentifier, java.lang.String publicIdentifier)
XmlProcessingInstruction	newProcessingInstruction(java.lang.String target, java.lang.String content)
Iterable	notations() An unordered set of notation information items, one for each notation declared in the DTD.
void	removeAllChildren()
void	removeAllNotations()
void	removeAllUnparsedEntities()
XmlElement	requiredElement(XmlNamespace n, java.lang.String name)
void	setCharacterEncodingScheme(java.lang.String characterEncoding)
void	setDocumentElement(XmlElement rootElement)
Iterable	unparsedEntities() An unordered set of unparsed entity information items, one for each unparsed entity declared in the DTD.

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

children

Iterable children()

An ordered list of child information items, in document order. The list contains exactly one element information item. The list also contains one processing instruction information item for each processing instruction outside the document element, and one comment information item for each comment outside the document element. Processing instructions and comments within the DTD are excluded. If there is a document type declaration, the list also contains a document type declaration information item.

getDocumentElement

XmlElement getDocumentElement()

requiredElement

XmlElement requiredElement(XmlNamespace n,
                           java.lang.String name)

element

XmlElement element(XmlNamespace n,
                   java.lang.String name)

element

XmlElement element(XmlNamespace n,
                   java.lang.String name,
                   boolean create)

notations

Iterable notations()

An unordered set of notation information items, one for each notation declared in the DTD.

unparsedEntities

Iterable unparsedEntities()

An unordered set of unparsed entity information items, one for each unparsed entity declared in the DTD.

getBaseUri

java.lang.String getBaseUri()

getCharacterEncodingScheme

java.lang.String getCharacterEncodingScheme()

setCharacterEncodingScheme

void setCharacterEncodingScheme(java.lang.String characterEncoding)

isStandalone

java.lang.Boolean isStandalone()

getVersion

java.lang.String getVersion()

isAllDeclarationsProcessed

boolean isAllDeclarationsProcessed()

setDocumentElement

void setDocumentElement(XmlElement rootElement)

addChild

void addChild(java.lang.Object child)

insertChild

void insertChild(int pos,
                 java.lang.Object child)

removeAllChildren

void removeAllChildren()

newComment

XmlComment newComment(java.lang.String content)

addComment

XmlComment addComment(java.lang.String content)

newDoctype

XmlDoctype newDoctype(java.lang.String systemIdentifier,
                      java.lang.String publicIdentifier)

addDoctype

XmlDoctype addDoctype(java.lang.String systemIdentifier,
                      java.lang.String publicIdentifier)

addDocumentElement

XmlElement addDocumentElement(java.lang.String name)

addDocumentElement

XmlElement addDocumentElement(XmlNamespace namespace,
                              java.lang.String name)

newProcessingInstruction

XmlProcessingInstruction newProcessingInstruction(java.lang.String target,
                                                  java.lang.String content)

addProcessingInstruction

XmlProcessingInstruction addProcessingInstruction(java.lang.String target,
                                                  java.lang.String content)

removeAllUnparsedEntities

void removeAllUnparsedEntities()

addNotation

XmlNotation addNotation(java.lang.String name,
                        java.lang.String systemIdentifier,
                        java.lang.String publicIdentifier,
                        java.lang.String declarationBaseUri)

removeAllNotations

void removeAllNotations()