EntityDeclaration (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.stream.events
interface EntityDeclaration

All Superinterfaces:: XMLEvent, XMLStreamConstants

public interface EntityDeclaration
extends XMLEvent

An interface for handling Entity Declarations This interface is used to record and report unparsed entity declarations.

Field Summary

Fields inherited from class javax.xml.stream.XMLStreamConstants
`ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT`

Method Summary
`String`	`getBaseURI()` Get the base URI for this reference or null if this information is not available
`String`	`getName()` The entity's name
`String`	`getNotationName()` The name of the associated notation.
`String`	`getPublicId()` The entity's public identifier, or null if none was given
`String`	`getReplacementText()` The replacement text of the entity.
`String`	`getSystemId()` The entity's system identifier.

Methods inherited from class javax.xml.stream.events.XMLEvent
`asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode`

Method Detail

getBaseURI

public String getBaseURI()

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

Returns:: the base URI or null

getName

public String getName()

The entity's name

Returns:: the name, may not be null

getNotationName

public String getNotationName()

The name of the associated notation.

Returns:: the notation name

getPublicId

public String getPublicId()

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

Returns:: the public ID for this declaration or null

getReplacementText

public String getReplacementText()

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

Returns:: null or the replacment text

getSystemId

public String getSystemId()

The entity's system identifier.

Returns:: the system ID for this declaration or null