Top Description Methods
com.sun.org.apache.xerces.internal.impl

public Interface XMLEntityHandler

Known Direct Implementers
com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl, com.sun.org.apache.xerces.internal.impl.XMLDTDScannerImpl
Imports
java.io.IOException, com.sun.org.apache.xerces.internal.xni.Augmentations, .XMLResourceIdentifier, .XNIException

The entity handler interface defines methods to report information about the start and end of entities.
Author
Andy Clark, IBM
See Also
com.sun.org.apache.xerces.internal.impl.XMLEntityScanner

Method Summary

Modifier and TypeMethod and Description
public void
endEntity(String
The name of the entity.
name
,
Augmentations
Additional information that may include infoset augmentations
augs
)

This method notifies the end of an entity.

public void
startEntity(String
The name of the 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
augs
)

This method notifies of the start of an entity.

Method Detail

endEntityback to summary
public void endEntity(String name, Augmentations augs) throws IOException, XNIException

This method notifies the end of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters
name:String

The name of the entity.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
IOException:
This exception might be thrown when there is premature end of entity
XNIException:
Thrown by handler to signal an error.
startEntityback to summary
public void startEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException

This method notifies of the start of an entity. The DTD has the pseudo-name of "[dtd]" parameter entity names start with '%'; and general entities are just specified by their name.

Parameters
name:String

The name of the 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).

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.