| javax.xml.stream.events.EntityDeclaration |
Class Overview
An interface for handling Entity Declarations
This interface is used to record and report unparsed entity declarations.
Summary
| Public Methods |
|---|
|
abstract
String
|
getBaseURI()
Get the base URI for this reference
or null if this information is not available
|
|
abstract
String
|
getName()
The entity's name
|
|
abstract
String
|
getNotationName()
The name of the associated notation.
|
|
abstract
String
|
getPublicId()
The entity's public identifier, or null if none was given
|
|
abstract
String
|
getReplacementText()
The replacement text of the entity.
|
|
abstract
String
|
getSystemId()
The entity's system identifier.
|
|
[Expand]
Inherited Methods |
|---|
From interface
javax.xml.stream.events.XMLEvent
|
abstract
Characters
|
asCharacters()
Returns this event as Characters, may result in
a class cast exception if this event is not Characters.
|
|
abstract
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.
|
|
abstract
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.
|
|
abstract
int
|
getEventType()
Returns an integer code for this event.
|
|
abstract
Location
|
getLocation()
Return the location of this event.
|
|
abstract
QName
|
getSchemaType()
This method is provided for implementations to provide
optional type information about the associated event.
|
|
abstract
boolean
|
isAttribute()
A utility function to check if this event is an Attribute.
|
|
abstract
boolean
|
isCharacters()
A utility function to check if this event is Characters.
|
|
abstract
boolean
|
isEndDocument()
A utility function to check if this event is an EndDocument.
|
|
abstract
boolean
|
isEndElement()
A utility function to check if this event is a EndElement.
|
|
abstract
boolean
|
isEntityReference()
A utility function to check if this event is an EntityReference.
|
|
abstract
boolean
|
isNamespace()
A utility function to check if this event is a Namespace.
|
|
abstract
boolean
|
isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction.
|
|
abstract
boolean
|
isStartDocument()
A utility function to check if this event is a StartDocument.
|
|
abstract
boolean
|
isStartElement()
A utility function to check if this event is a StartElement.
|
|
abstract
void
|
writeAsEncodedUnicode(Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
|
|
Public Methods
public
abstract
String
getBaseURI
()
Get the base URI for this reference
or null if this information is not available
public
abstract
String
getName
()
Returns
- the name, may not be null
public
abstract
String
getNotationName
()
The name of the associated notation.
public
abstract
String
getPublicId
()
The entity's public identifier, or null if none was given
Returns
- the public ID for this declaration or null
public
abstract
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 replacment text
public
abstract
String
getSystemId
()
The entity's system identifier.
Returns
- the system ID for this declaration or null