FileDocCategorySizeDatePackage
EntityReference.javaAPI DocJava SE 6 API1156Tue Jun 10 00:27:10 BST 2008javax.xml.stream.events

EntityReference

public interface EntityReference implements XMLEvent
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.
version
1.0
author
Copyright (c) 2003 by BEA Systems. All Rights Reserved.
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public javax.xml.stream.events.EntityDeclarationgetDeclaration()
Return the declaration of this entity.

public java.lang.StringgetName()
The name of the entity

return
the entity's name, may not be null