APIdia Launch Partner
Top Description Methods
javax.xml.stream.events

public Interface EntityDeclaration

extends XMLEvent
Known Direct Implementers
com.sun.xml.internal.stream.events.EntityDeclarationImpl

An interface for handling Entity Declarations This interface is used to record and report unparsed entity declarations.
Author
Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
Since
1.6
Version
1.0

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the base URI or null
getBaseURI
()

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

public String

Returns:

the name, may not be null
getName
()

The entity's name

public String

Returns:

the notation name
getNotationName
()

The name of the associated notation.

public String

Returns:

the public ID for this declaration or null
getPublicId
()

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

public String

Returns:

null or the replacement text
getReplacementText
()

The replacement text of the entity.

public String

Returns:

the system ID for this declaration or null
getSystemId
()

The entity's system identifier.

Inherited from javax.xml.stream.events.XMLEvent:
asCharactersasEndElementasStartElementgetEventTypegetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementwriteAsEncodedUnicode

Method Detail

getBaseURIback to summary
public String getBaseURI()

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

Returns:String

the base URI or null

getNameback to summary
public String getName()

The entity's name

Returns:String

the name, may not be null

getNotationNameback to summary
public String getNotationName()

The name of the associated notation.

Returns:String

the notation name

getPublicIdback to summary
public String getPublicId()

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

Returns:String

the public ID for this declaration or null

getReplacementTextback to summary
public String getReplacementText()

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

Returns:String

null or the replacement text

getSystemIdback to summary
public String getSystemId()

The entity's system identifier.

Returns:String

the system ID for this declaration or null