Interface EntityDeclaration

All Superinterfaces:: XMLEvent, XMLStreamConstants

public interface EntityDeclaration extends XMLEvent

An interface for handling Entity Declarations This interface is used to record and report unparsed entity declarations.

Since:: 1.6

Field Summary

Fields declared in interface XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Modifier and Type	Field	Description
`static final int`	`ATTRIBUTE`	Indicates an event is an attribute
`static final int`	`CDATA`	Indicates an event is a CDATA section
`static final int`	`CHARACTERS`	Indicates an event is characters
`static final int`	`COMMENT`	Indicates an event is a comment
`static final int`	`DTD`	Indicates an event is a DTD
`static final int`	`END_DOCUMENT`	Indicates an event is an end document
`static final int`	`END_ELEMENT`	Indicates an event is an end element
`static final int`	`ENTITY_DECLARATION`	Indicates a Entity Declaration
`static final int`	`ENTITY_REFERENCE`	Indicates an event is an entity reference
`static final int`	`NAMESPACE`	Indicates the event is a namespace declaration
`static final int`	`NOTATION_DECLARATION`	Indicates a Notation
`static final int`	`PROCESSING_INSTRUCTION`	Indicates an event is a processing instruction
`static final int`	`SPACE`	The characters are white space (see [XML], 2.10 "White Space Handling").
`static final int`	`START_DOCUMENT`	Indicates an event is a start document
`static final int`	`START_ELEMENT`	Indicates an event is a start element

Method Summary

Modifier and Type	Method	Description
`String`	`getBaseURI()`	Get the base URI for this reference or null if this information is not available
`String`	`getName()`	The entity's name
`String`	`getNotationName()`	The name of the associated notation.
`String`	`getPublicId()`	The entity's public identifier, or null if none was given
`String`	`getReplacementText()`	The replacement text of the entity.
`String`	`getSystemId()`	The entity's system identifier.

Methods declared in interface XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Modifier and Type	Method	Description
`Characters`	`asCharacters()`	Returns this event as Characters, may result in a class cast exception if this event is not Characters.
`EndElement`	`asEndElement()`	Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
`StartElement`	`asStartElement()`	Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
`int`	`getEventType()`	Returns an integer code for this event.
`Location`	`getLocation()`	Return the location of this event.
`QName`	`getSchemaType()`	This method is provided for implementations to provide optional type information about the associated event.
`boolean`	`isAttribute()`	A utility function to check if this event is an Attribute.
`boolean`	`isCharacters()`	A utility function to check if this event is Characters.
`boolean`	`isEndDocument()`	A utility function to check if this event is an EndDocument.
`boolean`	`isEndElement()`	A utility function to check if this event is a EndElement.
`boolean`	`isEntityReference()`	A utility function to check if this event is an EntityReference.
`boolean`	`isNamespace()`	A utility function to check if this event is a Namespace.
`boolean`	`isProcessingInstruction()`	A utility function to check if this event is a ProcessingInstruction.
`boolean`	`isStartDocument()`	A utility function to check if this event is a StartDocument.
`boolean`	`isStartElement()`	A utility function to check if this event is a StartElement.
`void`	`writeAsEncodedUnicode(Writer writer)`	This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.

Method Details

getPublicId

String getPublicId()

The entity's public identifier, or null if none was given

Returns:: the public ID for this declaration or null

getSystemId

String getSystemId()

The entity's system identifier.

Returns:: the system ID for this declaration or null

getName

String getName()

The entity's name

Returns:: the name, may not be null

getNotationName

String getNotationName()

The name of the associated notation.

Returns:: the notation name

getReplacementText

String getReplacementText()

The replacement text of the entity. This method will only return non-null if this is an internal entity.

Returns:: null or the replacement text

getBaseURI

String getBaseURI()

Get the base URI for this reference or null if this information is not available

Returns:: the base URI or null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.