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

Version:

1.0

Author:

Copyright (c) 2003 by BEA Systems. All Rights Reserved.

Field Summary

Fields inherited from 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

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

Methods inherited from interface javax.xml.stream.events.XMLEvent

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

Method Detail

getPublicId

java.lang.String getPublicId()

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

Returns:

the public ID for this declaration or null

getSystemId

java.lang.String getSystemId()

The entity's system identifier.

Returns:

the system ID for this declaration or null

getName

java.lang.String getName()

The entity's name

Returns:

the name, may not be null

getNotationName

java.lang.String getNotationName()

The name of the associated notation.

Returns:

the notation name

getReplacementText

java.lang.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

getBaseURI

java.lang.String getBaseURI()

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

Returns:

the base URI or null