public interface XMLDTDHandler
XMLDTDContentModelHandler
Modifier and Type | Field and Description |
---|---|
static short |
CONDITIONAL_IGNORE
Conditional section: IGNORE.
|
static short |
CONDITIONAL_INCLUDE
Conditional section: INCLUDE.
|
Modifier and Type | Method and Description |
---|---|
void |
attributeDecl(String elementName,
String attributeName,
String type,
String[] enumeration,
String defaultType,
XMLString defaultValue,
XMLString nonNormalizedDefaultValue,
Augmentations augmentations)
An attribute declaration.
|
void |
comment(XMLString text,
Augmentations augmentations)
A comment.
|
void |
elementDecl(String name,
String contentModel,
Augmentations augmentations)
An element declaration.
|
void |
endAttlist(Augmentations augmentations)
The end of an attribute list.
|
void |
endConditional(Augmentations augmentations)
The end of a conditional section.
|
void |
endDTD(Augmentations augmentations)
The end of the DTD.
|
void |
endExternalSubset(Augmentations augmentations)
The end of the DTD external subset.
|
void |
endParameterEntity(String name,
Augmentations augmentations)
This method notifies the end of a parameter entity.
|
void |
externalEntityDecl(String name,
XMLResourceIdentifier identifier,
Augmentations augmentations)
An external entity declaration.
|
XMLDTDSource |
getDTDSource() |
void |
ignoredCharacters(XMLString text,
Augmentations augmentations)
Characters within an IGNORE conditional section.
|
void |
internalEntityDecl(String name,
XMLString text,
XMLString nonNormalizedText,
Augmentations augmentations)
An internal entity declaration.
|
void |
notationDecl(String name,
XMLResourceIdentifier identifier,
Augmentations augmentations)
A notation declaration
|
void |
processingInstruction(String target,
XMLString data,
Augmentations augmentations)
A processing instruction.
|
void |
setDTDSource(XMLDTDSource source) |
void |
startAttlist(String elementName,
Augmentations augmentations)
The start of an attribute list.
|
void |
startConditional(short type,
Augmentations augmentations)
The start of a conditional section.
|
void |
startDTD(XMLLocator locator,
Augmentations augmentations)
The start of the DTD.
|
void |
startExternalSubset(XMLResourceIdentifier identifier,
Augmentations augmentations)
The start of the DTD external subset.
|
void |
startParameterEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augmentations)
This method notifies of the start of a parameter entity.
|
void |
textDecl(String version,
String encoding,
Augmentations augmentations)
Notifies of the presence of a TextDecl line in an entity.
|
void |
unparsedEntityDecl(String name,
XMLResourceIdentifier identifier,
String notation,
Augmentations augmentations)
An unparsed entity declaration.
|
static final short CONDITIONAL_INCLUDE
CONDITIONAL_IGNORE
,
Constant Field Valuesstatic final short CONDITIONAL_IGNORE
CONDITIONAL_INCLUDE
,
Constant Field Valuesvoid startDTD(XMLLocator locator, Augmentations augmentations) throws XNIException
locator
- The document locator, or null if the document
location cannot be reported during the parsing of
the document DTD. However, it is strongly
recommended that a locator be supplied that can
at least report the base system identifier of the
DTD.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void startParameterEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augmentations) throws XNIException
name
- The name of the parameter entity.identifier
- The resource identifier.encoding
- 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 parameter entities).augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void textDecl(String version, String encoding, Augmentations augmentations) throws XNIException
Note: This method is only called for external parameter entities referenced in the DTD.
version
- The XML version, or null if not specified.encoding
- The IANA encoding name of the entity.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void endParameterEntity(String name, Augmentations augmentations) throws XNIException
name
- The name of the parameter entity.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void startExternalSubset(XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException
identifier
- The resource identifier.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void endExternalSubset(Augmentations augmentations) throws XNIException
augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void comment(XMLString text, Augmentations augmentations) throws XNIException
text
- The text in the comment.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by application to signal an error.void processingInstruction(String target, XMLString data, Augmentations augmentations) throws XNIException
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.
target
- The target.data
- The data or null if none specified.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void elementDecl(String name, String contentModel, Augmentations augmentations) throws XNIException
name
- The name of the element.contentModel
- The element content model.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void startAttlist(String elementName, Augmentations augmentations) throws XNIException
elementName
- The name of the element that this attribute
list is associated with.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void attributeDecl(String elementName, String attributeName, String type, String[] enumeration, String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augmentations) throws XNIException
elementName
- The name of the element that this attribute
is associated with.attributeName
- The name of the attribute.type
- The attribute type. This value will be one of
the following: "CDATA", "ENTITY", "ENTITIES",
"ENUMERATION", "ID", "IDREF", "IDREFS",
"NMTOKEN", "NMTOKENS", or "NOTATION".enumeration
- If the type has the value "ENUMERATION" or
"NOTATION", this array holds the allowed attribute
values; otherwise, this array is null.defaultType
- The attribute default type. This value will be
one of the following: "#FIXED", "#IMPLIED",
"#REQUIRED", or null.defaultValue
- The attribute default value, or null if no
default value is specified.nonNormalizedDefaultValue
- The attribute default value with no normalization
performed, or null if no default value is specified.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void endAttlist(Augmentations augmentations) throws XNIException
augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void internalEntityDecl(String name, XMLString text, XMLString nonNormalizedText, Augmentations augmentations) throws XNIException
name
- The name of the entity. Parameter entity names start with
'%', whereas the name of a general entity is just the
entity name.text
- The value of the entity.nonNormalizedText
- The non-normalized value of the entity. This
value contains the same sequence of characters that was in
the internal entity declaration, without any entity
references expanded.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void externalEntityDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException
name
- The name of the entity. Parameter entity names start
with '%', whereas the name of a general entity is just
the entity name.identifier
- An object containing all location information
pertinent to this external entity.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void unparsedEntityDecl(String name, XMLResourceIdentifier identifier, String notation, Augmentations augmentations) throws XNIException
name
- The name of the entity.identifier
- An object containing all location information
pertinent to this unparsed entity declaration.notation
- The name of the notation.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void notationDecl(String name, XMLResourceIdentifier identifier, Augmentations augmentations) throws XNIException
name
- The name of the notation.identifier
- An object containing all location information
pertinent to this notation.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void startConditional(short type, Augmentations augmentations) throws XNIException
type
- The type of the conditional section. This value will
either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.CONDITIONAL_INCLUDE
,
CONDITIONAL_IGNORE
void ignoredCharacters(XMLString text, Augmentations augmentations) throws XNIException
text
- The ignored text.augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void endConditional(Augmentations augmentations) throws XNIException
augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void endDTD(Augmentations augmentations) throws XNIException
augmentations
- Additional information that may include infoset
augmentations.XNIException
- Thrown by handler to signal an error.void setDTDSource(XMLDTDSource source)
XMLDTDSource getDTDSource()
Copyright © 2021 JBoss by Red Hat. All rights reserved.