Class DTDHandlerBase
- java.lang.Object
-
- com.sun.xml.dtdparser.DTDHandlerBase
-
- All Implemented Interfaces:
DTDEventListener
,EventListener
public class DTDHandlerBase extends Object implements DTDEventListener
do-nothing implementation of DTDEventHandler.
-
-
Field Summary
-
Fields inherited from interface com.sun.xml.dtdparser.DTDEventListener
CHOICE, CONTENT_MODEL_ANY, CONTENT_MODEL_CHILDREN, CONTENT_MODEL_EMPTY, CONTENT_MODEL_MIXED, OCCURENCE_ONCE, OCCURENCE_ONE_OR_MORE, OCCURENCE_ZERO_OR_MORE, OCCURENCE_ZERO_OR_ONE, SEQUENCE, USE_FIXED, USE_IMPLIED, USE_NORMAL, USE_REQUIRED
-
-
Constructor Summary
Constructors Constructor Description DTDHandlerBase()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
attributeDecl(String elementName, String attributeName, String attributeType, String[] enumeration, short attributeUse, String defaultValue)
For each entry in an ATTLIST declaration, this event will be fired.void
characters(char[] ch, int start, int length)
Receive notification of character data.void
childElement(String elementName, short occurence)
void
comment(String n)
Receive notification that a comment has been read.void
connector(short connectorType)
Connectors in one model group is guaranteed to be the same.void
endCDATA()
Receive notification that the CDATA section finished.void
endContentModel(String elementName, short contentModelType)
receives notification that parsing of content model is finished.void
endDTD()
Receive notification of the end of a DTD.void
endModelGroup(short occurence)
void
error(SAXParseException e)
void
externalGeneralEntityDecl(String n, String p, String s)
Receive notification of an external parsed general entity declaration event.void
externalParameterEntityDecl(String n, String p, String s)
Receive notification of an external parameter entity declaration event.void
fatalError(SAXParseException e)
void
ignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.void
internalGeneralEntityDecl(String n, String v)
Receive notification of a internal general entity declaration event.void
internalParameterEntityDecl(String n, String v)
Receive notification of a internal parameter entity declaration event.void
mixedElement(String elementName)
receives notification of child element of mixed content model.void
notationDecl(String name, String publicId, String systemId)
Receive notification of a Notation Declaration.void
processingInstruction(String target, String data)
Receive notification of a Processing Instruction.void
setDocumentLocator(Locator loc)
void
startCDATA()
Receive notification that a CDATA section is beginning.void
startContentModel(String elementName, short contentModelType)
receives notification that parsing of content model is beginning.void
startDTD(InputEntity in)
Receive notification of the beginning of the DTD.void
startModelGroup()
void
unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.void
warning(SAXParseException err)
-
-
-
Method Detail
-
processingInstruction
public void processingInstruction(String target, String data) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of a Processing Instruction. Processing instructions contain information meaningful to the application.- Specified by:
processingInstruction
in interfaceDTDEventListener
- Parameters:
target
- The target of the proceessing instruction which should have meaning to the application.data
- The instruction itself which should contain valid XML characters.- Throws:
SAXException
-
setDocumentLocator
public void setDocumentLocator(Locator loc)
- Specified by:
setDocumentLocator
in interfaceDTDEventListener
-
fatalError
public void fatalError(SAXParseException e) throws SAXException
- Specified by:
fatalError
in interfaceDTDEventListener
- Throws:
SAXException
-
error
public void error(SAXParseException e) throws SAXException
- Specified by:
error
in interfaceDTDEventListener
- Throws:
SAXException
-
warning
public void warning(SAXParseException err) throws SAXException
- Specified by:
warning
in interfaceDTDEventListener
- Throws:
SAXException
-
notationDecl
public void notationDecl(String name, String publicId, String systemId) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of a Notation Declaration. Notation declarations are used by elements and entities for identifying embedded non-XML data.- Specified by:
notationDecl
in interfaceDTDEventListener
- Parameters:
name
- The notation name, referred to by entities and elements.publicId
- The public identifiersystemId
- The system identifier- Throws:
SAXException
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of an unparsed entity declaration. Unparsed entities are non-XML data.- Specified by:
unparsedEntityDecl
in interfaceDTDEventListener
- Parameters:
name
- The name of the unparsed entity.publicId
- The public identifiersystemId
- The system identifiernotationName
- The associated notation- Throws:
SAXException
-
endDTD
public void endDTD() throws SAXException
Description copied from interface:DTDEventListener
Receive notification of the end of a DTD. The parser will invoke this method only once.- Specified by:
endDTD
in interfaceDTDEventListener
- Throws:
SAXException
- See Also:
DTDEventListener.startDTD(InputEntity)
-
externalGeneralEntityDecl
public void externalGeneralEntityDecl(String n, String p, String s) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of an external parsed general entity declaration event.If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.
- Specified by:
externalGeneralEntityDecl
in interfaceDTDEventListener
- Parameters:
n
- The entity name.p
- The entity's public identifier, or null if none was given.s
- The entity's system identifier.- Throws:
SAXException
- See Also:
DTDEventListener.unparsedEntityDecl(String, String, String, String)
-
internalGeneralEntityDecl
public void internalGeneralEntityDecl(String n, String v) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of a internal general entity declaration event.- Specified by:
internalGeneralEntityDecl
in interfaceDTDEventListener
- Parameters:
n
- The internal general entity name.v
- The value of the entity, which may include unexpanded entity references. Character references will have been expanded.- Throws:
SAXException
- See Also:
DTDEventListener.externalGeneralEntityDecl(String, String, String)
-
externalParameterEntityDecl
public void externalParameterEntityDecl(String n, String p, String s) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of an external parameter entity declaration event.If a system identifier is present, and it is a relative URL, the parser will have resolved it fully before passing it through this method to a listener.
- Specified by:
externalParameterEntityDecl
in interfaceDTDEventListener
- Parameters:
n
- The parameter entity name.p
- The entity's public identifier, or null if none was given.s
- The entity's system identifier.- Throws:
SAXException
- See Also:
DTDEventListener.unparsedEntityDecl(String, String, String, String)
-
internalParameterEntityDecl
public void internalParameterEntityDecl(String n, String v) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of a internal parameter entity declaration event.- Specified by:
internalParameterEntityDecl
in interfaceDTDEventListener
- Parameters:
n
- The internal parameter entity name.v
- The value of the entity, which may include unexpanded entity references. Character references will have been expanded.- Throws:
SAXException
- See Also:
DTDEventListener.externalParameterEntityDecl(String, String, String)
-
startDTD
public void startDTD(InputEntity in) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of the beginning of the DTD.- Specified by:
startDTD
in interfaceDTDEventListener
- Parameters:
in
- Current input entity.- Throws:
SAXException
- See Also:
DTDEventListener.endDTD()
-
comment
public void comment(String n) throws SAXException
Description copied from interface:DTDEventListener
Receive notification that a comment has been read.Note that processing instructions are the mechanism designed to hold information for consumption by applications, not comments. XML systems may rely on applications being able to access information found in processing instructions; this is not true of comments, which are typically discarded.
- Specified by:
comment
in interfaceDTDEventListener
- Parameters:
n
- the text within the comment delimiters.- Throws:
SAXException
-
characters
public void characters(char[] ch, int start, int length) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of character data.The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
- Specified by:
characters
in interfaceDTDEventListener
- Parameters:
ch
- The characters from the DTD.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- See Also:
DTDEventListener.ignorableWhitespace(char[], int, int)
-
ignorableWhitespace
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Description copied from interface:DTDEventListener
Receive notification of ignorable whitespace in element content.Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
- Specified by:
ignorableWhitespace
in interfaceDTDEventListener
- Parameters:
ch
- The characters from the DTD.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- See Also:
DTDEventListener.characters(char[], int, int)
-
startCDATA
public void startCDATA() throws SAXException
Description copied from interface:DTDEventListener
Receive notification that a CDATA section is beginning. Data in a CDATA section is is reported through the appropriate event, either characters() or ignorableWhitespace.- Specified by:
startCDATA
in interfaceDTDEventListener
- Throws:
SAXException
- See Also:
DTDEventListener.endCDATA()
-
endCDATA
public void endCDATA() throws SAXException
Description copied from interface:DTDEventListener
Receive notification that the CDATA section finished.- Specified by:
endCDATA
in interfaceDTDEventListener
- Throws:
SAXException
- See Also:
DTDEventListener.startCDATA()
-
startContentModel
public void startContentModel(String elementName, short contentModelType) throws SAXException
Description copied from interface:DTDEventListener
receives notification that parsing of content model is beginning.- Specified by:
startContentModel
in interfaceDTDEventListener
- Parameters:
elementName
- name of the element whose content model is going to be defined.contentModelType
-DTDEventListener.CONTENT_MODEL_EMPTY
this element has EMPTY content model. This notification will be immediately followed by the corresponding endContentModel.DTDEventListener.CONTENT_MODEL_ANY
this element has ANY content model. This notification will be immediately followed by the corresponding endContentModel.DTDEventListener.CONTENT_MODEL_MIXED
this element has mixed content model. #PCDATA will not be reported. each child element will be reported by mixedElement method.DTDEventListener.CONTENT_MODEL_CHILDREN
this elemen has child content model. The actual content model will be reported by childElement, startModelGroup, endModelGroup, and connector methods. Possible call sequences are:START := MODEL_GROUP MODEL_GROUP := startModelGroup TOKEN (connector TOKEN)* endModelGroup TOKEN := childElement | MODEL_GROUP
- Throws:
SAXException
-
endContentModel
public void endContentModel(String elementName, short contentModelType) throws SAXException
Description copied from interface:DTDEventListener
receives notification that parsing of content model is finished.- Specified by:
endContentModel
in interfaceDTDEventListener
- Throws:
SAXException
-
attributeDecl
public void attributeDecl(String elementName, String attributeName, String attributeType, String[] enumeration, short attributeUse, String defaultValue) throws SAXException
Description copied from interface:DTDEventListener
For each entry in an ATTLIST declaration, this event will be fired.DTD allows the same attributes to be declared more than once, and in that case the first one wins. I think this method will be only fired for the first one, but I need to check.
- Specified by:
attributeDecl
in interfaceDTDEventListener
- Throws:
SAXException
-
childElement
public void childElement(String elementName, short occurence) throws SAXException
- Specified by:
childElement
in interfaceDTDEventListener
- Throws:
SAXException
-
mixedElement
public void mixedElement(String elementName) throws SAXException
Description copied from interface:DTDEventListener
receives notification of child element of mixed content model. this method is called for each child element.- Specified by:
mixedElement
in interfaceDTDEventListener
- Throws:
SAXException
- See Also:
DTDEventListener.startContentModel(String, short)
-
startModelGroup
public void startModelGroup() throws SAXException
- Specified by:
startModelGroup
in interfaceDTDEventListener
- Throws:
SAXException
-
endModelGroup
public void endModelGroup(short occurence) throws SAXException
- Specified by:
endModelGroup
in interfaceDTDEventListener
- Throws:
SAXException
-
connector
public void connector(short connectorType) throws SAXException
Description copied from interface:DTDEventListener
Connectors in one model group is guaranteed to be the same.IOW, you'll never see an event sequence like (a|b,c)
- Specified by:
connector
in interfaceDTDEventListener
- Throws:
SAXException
-
-