Top Fields Constructors Methods
org.apache.xerces.stax.events

public final Class EntityDeclarationImpl

extends XMLEventImpl
implements EntityDeclaration
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
java.io.IOException, .Writer, javax.xml.stream.Location, .XMLStreamException, javax.xml.stream.events.EntityDeclaration
Author
Lucian Holland
Version
$Id: EntityDeclarationImpl.java 730471 2008-12-31 20:45:32Z mrglavas $

Field Summary

Modifier and TypeField and Description
private final String
fName

private final String
fNotationName

private final String
fPublicId

private final String
fSystemId

Constructor Summary

AccessConstructor and Description
public
EntityDeclarationImpl(final String publicId, final String systemId, final String name, final String notationName, final Location location)

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
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 void
writeAsEncodedUnicode(Writer
The writer that will output the data
writer)

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
Inherited from org.apache.xerces.stax.events.XMLEventImpl:
asCharactersasEndElementasStartElementgetEventTypegetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementtoString

Field Detail

fNameback to summary
private final String fName
fNotationNameback to summary
private final String fNotationName
fPublicIdback to summary
private final String fPublicId
fSystemIdback to summary
private final String fSystemId

Constructor Detail

EntityDeclarationImplback to summary
public EntityDeclarationImpl(final String publicId, final String systemId, final String name, final String notationName, final Location location)

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

See Also
javax.xml.stream.events.EntityDeclaration#getBaseURI()
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

See Also
javax.xml.stream.events.EntityDeclaration#getName()
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

See Also
javax.xml.stream.events.EntityDeclaration#getNotationName()
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

See Also
javax.xml.stream.events.EntityDeclaration#getPublicId()
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

See Also
javax.xml.stream.events.EntityDeclaration#getReplacementText()
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

See Also
javax.xml.stream.events.EntityDeclaration#getSystemId()
writeAsEncodedUnicodeback to summary
public void writeAsEncodedUnicode(Writer writer) throws XMLStreamException

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

Doc from javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.

Parameters
writer:Writer

The writer that will output the data

Exceptions
XMLStreamException:
if there is a fatal error writing the event