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

public Interface EntityReference

extends XMLEvent
Known Direct Implementers
com.sun.xml.internal.stream.events.EntityReferenceEvent
An interface for handling Entity events. This event reports entities that have not been resolved and reports their replacement text unprocessed (if available). This event will be reported if javax.xml.stream.isReplacingEntityReferences is set to false. If javax.xml.stream.isReplacingEntityReferences is set to true entity references will be resolved transparently. Entities are handled in two possible ways: (1) If javax.xml.stream.isReplacingEntityReferences is set to true all entity references are resolved and reported as markup transparently. (2) If javax.xml.stream.isReplacingEntityReferences is set to false Entity references are reported as an EntityReference Event.
Author
Copyright (c) 2009 by Oracle Corporation. All Rights Reserved.
Since
1.6
Version
1.0

Method Summary

Modifier and TypeMethod and Description
public EntityDeclaration

Returns:

the declaration
getDeclaration()

Return the declaration of this entity.

public String

Returns:

the entity's name, may not be null
getName()

The name of the entity

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

Method Detail

getDeclarationback to summary
public EntityDeclaration getDeclaration()

Return the declaration of this entity.

Returns:EntityDeclaration

the declaration

getNameback to summary
public String getName()

The name of the entity

Returns:String

the entity's name, may not be null