APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.jaxp

pack-priv final Class UnparsedEntityHandler

extends Object
implements XMLDTDFilter, EntityState
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.impl.validation.EntityState, com.sun.org.apache.xerces.internal.xni.parser.XMLDTDFilter, com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource, com.sun.org.apache.xerces.internal.xni.XMLDTDHandler
Imports
com.sun.org.apache.xerces.internal.impl.validation.EntityState, .ValidationManager, com.sun.org.apache.xerces.internal.xni.Augmentations, .XMLDTDHandler, .XMLLocator, .XMLResourceIdentifier, .XMLString, .XNIException, com.sun.org.apache.xerces.internal.xni.parser.XMLDTDFilter, .XMLDTDSource, java.util.HashMap, .Map

This filter records which unparsed entities have been declared in the DTD and provides this information to a ValidationManager. Events are forwarded to the registered XMLDTDHandler without modification.

Author
Michael Glavassevich, IBM

Field Summary

Modifier and TypeField and Description
private XMLDTDHandler
private XMLDTDSource
fDTDSource

DTD source and handler.

private Map<String, String>
fUnparsedEntities

Map for tracking unparsed entities.

private final ValidationManager
fValidationManager

Validation manager.

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.attributeDecl.

An attribute declaration.

public void
public void
elementDecl(String name, String contentModel, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.elementDecl.

An element declaration.

public void
endAttlist(Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endAttlist.

The end of an attribute list.

public void
endConditional(Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endConditional.

The end of a conditional section.

public void
public void
public void
endParameterEntity(String name, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endParameterEntity.

This method notifies the end of a parameter entity.

public void
public XMLDTDHandler
public XMLDTDSource
public void
ignoredCharacters(XMLString text, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.ignoredCharacters.

Characters within an IGNORE conditional section.

public void
internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.internalEntityDecl.

An internal entity declaration.

public boolean
isEntityDeclared(String name)

Implements com.sun.org.apache.xerces.internal.impl.validation.EntityState.isEntityDeclared.

Query method to check if entity with this name was declared.

public boolean
public void
public void
public void
public void
public void
public void
startAttlist(String elementName, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startAttlist.

The start of an attribute list.

public void
startConditional(short type, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startConditional.

The start of a conditional section.

public void
public void
public void
startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startParameterEntity.

This method notifies of the start of a parameter entity.

public void
textDecl(String version, String encoding, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.textDecl.

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

public void
unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.unparsedEntityDecl.

An unparsed entity declaration.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fDTDHandlerback to summary
private XMLDTDHandler fDTDHandler
fDTDSourceback to summary
private XMLDTDSource fDTDSource

DTD source and handler.

fUnparsedEntitiesback to summary
private Map<String, String> fUnparsedEntities

Map for tracking unparsed entities.

fValidationManagerback to summary
private final ValidationManager fValidationManager

Validation manager.

Constructor Detail

UnparsedEntityHandlerback to summary
pack-priv UnparsedEntityHandler(ValidationManager manager)

Method Detail

attributeDeclback to summary
public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.attributeDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.attributeDecl.

An attribute declaration.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.comment.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.comment.

A comment.

Exceptions
XNIException:
Thrown by application to signal an error.
elementDeclback to summary
public void elementDecl(String name, String contentModel, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.elementDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.elementDecl.

An element declaration.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endAttlist.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endAttlist.

The end of an attribute list.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endConditional.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endConditional.

The end of a conditional section.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endDTD.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endDTD.

The end of the DTD.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endExternalSubset.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endExternalSubset.

The end of the DTD external subset.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endParameterEntity.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.endParameterEntity.

This method notifies the end of a parameter entity. Parameter entity names begin with a '%' character.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.externalEntityDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.externalEntityDecl.

An external entity declaration.

Exceptions
XNIException:
Thrown by handler to signal an error.
getDTDHandlerback to summary
public XMLDTDHandler getDTDHandler()

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource.getDTDHandler.

Doc from com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource.getDTDHandler.

Returns the DTD handler.

getDTDSourceback to summary
public XMLDTDSource getDTDSource()

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.getDTDSource.

ignoredCharactersback to summary
public void ignoredCharacters(XMLString text, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.ignoredCharacters.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.ignoredCharacters.

Characters within an IGNORE conditional section.

Exceptions
XNIException:
Thrown by handler to signal an error.
internalEntityDeclback to summary
public void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.internalEntityDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.internalEntityDecl.

An internal entity declaration.

Exceptions
XNIException:
Thrown by handler to signal an error.
isEntityDeclaredback to summary
public boolean isEntityDeclared(String name)

Implements com.sun.org.apache.xerces.internal.impl.validation.EntityState.isEntityDeclared.

Doc from com.sun.org.apache.xerces.internal.impl.validation.EntityState.isEntityDeclared.

Query method to check if entity with this name was declared.

isEntityUnparsedback to summary
public boolean isEntityUnparsed(String name)

Implements com.sun.org.apache.xerces.internal.impl.validation.EntityState.isEntityUnparsed.

Doc from com.sun.org.apache.xerces.internal.impl.validation.EntityState.isEntityUnparsed.

Query method to check if entity is unparsed.

notationDeclback to summary
public void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.notationDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.notationDecl.

A notation declaration

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.processingInstruction.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.processingInstruction.

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.

Exceptions
XNIException:
Thrown by handler to signal an error.
resetback to summary
public void reset()
setDTDHandlerback to summary
public void setDTDHandler(XMLDTDHandler handler)

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource.setDTDHandler.

Doc from com.sun.org.apache.xerces.internal.xni.parser.XMLDTDSource.setDTDHandler.

Sets the DTD handler.

setDTDSourceback to summary
public void setDTDSource(XMLDTDSource source)

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.setDTDSource.

startAttlistback to summary
public void startAttlist(String elementName, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startAttlist.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startAttlist.

The start of an attribute list.

Exceptions
XNIException:
Thrown by handler to signal an error.
startConditionalback to summary
public void startConditional(short type, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startConditional.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startConditional.

The start of a conditional section.

Exceptions
XNIException:
Thrown by handler to signal an error.
startDTDback to summary
public void startDTD(XMLLocator locator, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startDTD.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startDTD.

The start of the DTD.

Exceptions
XNIException:
Thrown by handler to signal an error.
startExternalSubsetback to summary
public void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startExternalSubset.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startExternalSubset.

The start of the DTD external subset.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startParameterEntity.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.startParameterEntity.

This method notifies of the start of a parameter entity. The parameter entity name start with a '%' character.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.textDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.textDecl.

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 is only called for external parameter entities referenced in the DTD.

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.unparsedEntityDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDTDHandler.unparsedEntityDecl.

An unparsed entity declaration.

Exceptions
XNIException:
Thrown by handler to signal an error.