W3cubDocs

/OpenJDK 21

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 javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, 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 javax.xml.stream.events.XMLEvent

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

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, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/stream/events/EntityDeclaration.html