APIdia Launch Partner
Top Description Methods
com.sun.org.apache.xerces.internal.xni

public Interface XMLDocumentFragmentHandler


This handler interface contains methods necessary to receive information about document elements and content.

Note

Some of these methods overlap methods found in the XMLDocumentHandler interface.

Author
Andy Clark, IBM
See Also
XMLDocumentHandler

Method Summary

Modifier and TypeMethod and Description
public void
characters(XMLString
The content.
text
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

Character content.

public void
comment(XMLString
The text in the comment.
text
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

A comment.

public void
emptyElement(QName
The name of the element.
element
,
XMLAttributes
The element attributes.
attributes
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

An empty element.

public void
endCDATA(Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The end of a CDATA section.

public void
endDocumentFragment(Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The end of the document fragment.

public void
endElement(QName
The name of the element.
element
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The end of an element.

public void
endGeneralEntity(String
The name of the general entity.
name
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

This method notifies the end of a general entity.

public void
ignorableWhitespace(XMLString
The ignorable whitespace.
text
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

Ignorable whitespace.

public void
processingInstruction(String
The target.
target
,
XMLString
The data or null if none specified.
data
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

A processing instruction.

public void
startCDATA(Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The start of a CDATA section.

public void
startDocumentFragment(XMLLocator
The document locator, or null if the document location cannot be reported during the parsing of this fragment. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier.
locator
,
NamespaceContext
The namespace context in effect at the start of this document fragment. This object only represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
namespaceContext
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The start of the document fragment.

public void
startElement(QName
The name of the element.
element
,
XMLAttributes
The element attributes.
attributes
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

The start of an element.

public void
startGeneralEntity(String
The name of the general entity.
name
,
XMLResourceIdentifier
The resource identifier.
identifier
,
String
The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
encoding
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

This method notifies the start of a general entity.

public void
textDecl(String
The XML version, or null if not specified.
version
,
String
The IANA encoding name of the entity.
encoding
,
Augmentations
Additional information that may include infoset augmentations.
augmentations
)

Notifies of the presence of a TextDecl line in an entity.

Method Detail

charactersback to summary
public void characters(XMLString text, Augmentations augmentations) throws XNIException

Character content.

Parameters
text:XMLString

The content.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
commentback to summary
public void comment(XMLString text, Augmentations augmentations) throws XNIException

A comment.

Parameters
text:XMLString

The text in the comment.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by application to signal an error.
emptyElementback to summary
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augmentations) throws XNIException

An empty element.

Parameters
element:QName

The name of the element.

attributes:XMLAttributes

The element attributes.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
endCDATAback to summary
public void endCDATA(Augmentations augmentations) throws XNIException

The end of a CDATA section.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
endDocumentFragmentback to summary
public void endDocumentFragment(Augmentations augmentations) throws XNIException

The end of the document fragment.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
endElementback to summary
public void endElement(QName element, Augmentations augmentations) throws XNIException

The end of an element.

Parameters
element:QName

The name of the element.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
endGeneralEntityback to summary
public void endGeneralEntity(String name, Augmentations augmentations) throws XNIException

This method notifies the end of a general entity.

Note

This method is not called for entity references appearing as part of attribute values.

Parameters
name:String

The name of the general entity.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
ignorableWhitespaceback to summary
public void ignorableWhitespace(XMLString text, Augmentations augmentations) throws XNIException

Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.

Parameters
text:XMLString

The ignorable whitespace.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
processingInstructionback to summary
public void processingInstruction(String target, XMLString data, Augmentations augmentations) throws XNIException

A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

Parameters
target:String

The target.

data:XMLString

The data or null if none specified.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
startCDATAback to summary
public void startCDATA(Augmentations augmentations) throws XNIException

The start of a CDATA section.

Parameters
augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
startDocumentFragmentback to summary
public void startDocumentFragment(XMLLocator locator, NamespaceContext namespaceContext, Augmentations augmentations) throws XNIException

The start of the document fragment.

Parameters
locator:XMLLocator

The document locator, or null if the document location cannot be reported during the parsing of this fragment. However, it is strongly recommended that a locator be supplied that can at least report the base system identifier.

namespaceContext:NamespaceContext

The namespace context in effect at the start of this document fragment. This object only represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
startElementback to summary
public void startElement(QName element, XMLAttributes attributes, Augmentations augmentations) throws XNIException

The start of an element.

Parameters
element:QName

The name of the element.

attributes:XMLAttributes

The element attributes.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
startGeneralEntityback to summary
public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations) throws XNIException

This method notifies the start of a general entity.

Note

This method is not called for entity references appearing as part of attribute values.

Parameters
name:String

The name of the general entity.

identifier:XMLResourceIdentifier

The resource identifier.

encoding:String

The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.
textDeclback to summary
public void textDecl(String version, String encoding, Augmentations augmentations) throws XNIException

Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.

Note

This method will never be called for the document entity; it is only called for external general entities referenced in document content.

Note

This method is not called for entity references appearing as part of attribute values.

Parameters
version:String

The XML version, or null if not specified.

encoding:String

The IANA encoding name of the entity.

augmentations:Augmentations

Additional information that may include infoset augmentations.

Exceptions
XNIException:
Thrown by handler to signal an error.