Top Description Fields Constructors Methods
com.sun.xml.internal.stream.events

public Class EntityDeclarationImpl

extends DummyEvent
implements EntityDeclaration
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
javax.xml.stream.events.EntityDeclaration, .XMLEvent, com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier, jdk.xml.internal.JdkXmlUtils
This class store all the information for a particular EntityDeclaration. EntityDeclaration interface has various get* functions to retrieve information about a particular EntityDeclaration.
Author
Neeraj Bajaj, Sun Microsystems.

Field Summary

Modifier and TypeField and Description
private String
fEntityName

private String
fNotationName

private String
fReplacementText

private XMLResourceIdentifier
fXMLResourceIdentifier

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
fLocation

Constructor Summary

AccessConstructor and Description
public
EntityDeclarationImpl()

Creates a new instance of EntityDeclarationImpl

public
EntityDeclarationImpl(String entityName, String replacementText)

public
EntityDeclarationImpl(String entityName, String replacementText, XMLResourceIdentifier resourceIdentifier)

Method Summary

Modifier and TypeMethod and Description
public String
getBaseURI()

Implements javax.xml.stream.events.EntityDeclaration.getBaseURI.

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

public String
getEntityName()

public String
getName()

Implements javax.xml.stream.events.EntityDeclaration.getName.

The entity's name

public String
getNotationName()

Implements javax.xml.stream.events.EntityDeclaration.getNotationName.

The name of the associated notation.

public String
getPublicId()

Implements javax.xml.stream.events.EntityDeclaration.getPublicId.

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

public String
getReplacementText()

Implements javax.xml.stream.events.EntityDeclaration.getReplacementText.

The replacement text of the entity.

public String
getSystemId()

Implements javax.xml.stream.events.EntityDeclaration.getSystemId.

The entity's system identifier.

public XMLResourceIdentifier
getXMLResourceIdentifier()

protected void
init()

public void
setEntityName(String entityName)

public void
setEntityReplacementText(String replacementText)

public void
setNotationName(String notationName)

public void
setXMLResourceIdentifier(XMLResourceIdentifier resourceIdentifier)

protected void
writeAsEncodedUnicodeEx(Writer
The writer that will output the data
writer)

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
asCharactersasEndElementasStartElementcharEncodegetEventTypegetLocationgetSchemaTypeisAttributeisCharacterDataisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementsetEventTypesetLocationwriteAsEncodedUnicode

Field Detail

fEntityNameback to summary
private String fEntityName
fNotationNameback to summary
private String fNotationName
fReplacementTextback to summary
private String fReplacementText
fXMLResourceIdentifierback to summary
private XMLResourceIdentifier fXMLResourceIdentifier

Constructor Detail

EntityDeclarationImplback to summary
public EntityDeclarationImpl()

Creates a new instance of EntityDeclarationImpl

EntityDeclarationImplback to summary
public EntityDeclarationImpl(String entityName, String replacementText)
EntityDeclarationImplback to summary
public EntityDeclarationImpl(String entityName, String replacementText, XMLResourceIdentifier resourceIdentifier)

Method Detail

getBaseURIback to summary
public String getBaseURI()

Implements javax.xml.stream.events.EntityDeclaration.getBaseURI.

Doc from javax.xml.stream.events.EntityDeclaration.getBaseURI.

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

Returns:String

the base URI or null

getEntityNameback to summary
public String getEntityName()
getNameback to summary
public String getName()

Implements javax.xml.stream.events.EntityDeclaration.getName.

Doc from javax.xml.stream.events.EntityDeclaration.getName.

The entity's name

Returns:String

the name, may not be null

getNotationNameback to summary
public String getNotationName()

Implements javax.xml.stream.events.EntityDeclaration.getNotationName.

Doc from javax.xml.stream.events.EntityDeclaration.getNotationName.

The name of the associated notation.

Returns:String

the notation name

getPublicIdback to summary
public String getPublicId()

Implements javax.xml.stream.events.EntityDeclaration.getPublicId.

Doc from javax.xml.stream.events.EntityDeclaration.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()

Implements javax.xml.stream.events.EntityDeclaration.getReplacementText.

Doc from javax.xml.stream.events.EntityDeclaration.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()

Implements javax.xml.stream.events.EntityDeclaration.getSystemId.

Doc from javax.xml.stream.events.EntityDeclaration.getSystemId.

The entity's system identifier.

Returns:String

the system ID for this declaration or null

getXMLResourceIdentifierback to summary
public XMLResourceIdentifier getXMLResourceIdentifier()
initback to summary
protected void init()
setEntityNameback to summary
public void setEntityName(String entityName)
setEntityReplacementTextback to summary
public void setEntityReplacementText(String replacementText)
setNotationNameback to summary
public void setNotationName(String notationName)
setXMLResourceIdentifierback to summary
public void setXMLResourceIdentifier(XMLResourceIdentifier resourceIdentifier)
writeAsEncodedUnicodeExback to summary
protected void writeAsEncodedUnicodeEx(Writer writer) throws IOException

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Doc from com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Parameters
writer:Writer

The writer that will output the data

Exceptions
IOException:
if there is an IO error