com.bea.xml.stream.events
Class DTDEvent

java.lang.Object
  com.bea.xml.stream.events.BaseEvent
      com.bea.xml.stream.events.DTDEvent

All Implemented Interfaces:

javax.xml.stream.events.DTD, javax.xml.stream.events.XMLEvent, javax.xml.stream.Location, javax.xml.stream.XMLStreamConstants

public class DTDEvent
extends BaseEvent
implements javax.xml.stream.events.DTD

Field Summary

Fields inherited from interface 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

Constructor Summary

DTDEvent()

DTDEvent(java.lang.String dtd)

Method Summary

java.lang.String	getDocumentTypeDeclaration() Returns the entire Document Type Declaration as a string, including the internal DTD subset.
java.util.List	getEntities() Return a List containing the general entities, both external and internal, declared in the DTD.
java.util.List	getNotations() Return a List containing the notations declared in the DTD.
java.lang.Object	getProcessedDTD() Returns an implementation defined representation of the DTD.
protected void	init()
void	setDTD(java.lang.String dtd)
java.lang.String	toString()

Methods inherited from class com.bea.xml.stream.events.BaseEvent

asCharacters, asEndElement, asStartElement, getCharacterOffset, getColumnNumber, getEventType, getLineNumber, getLocation, getLocationURI, getPublicId, getSchemaType, getSourceName, getSystemId, getTypeAsString, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, recycle, setCharacterOffset, setColumnNumber, setEventType, setLineNumber, setLocationURI, writeAsEncodedUnicode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.stream.events.XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Constructor Detail

DTDEvent

public DTDEvent()

DTDEvent

public DTDEvent(java.lang.String dtd)

Method Detail

init

protected void init()

setDTD

public void setDTD(java.lang.String dtd)

getProcessedDTD

public java.lang.Object getProcessedDTD()

Description copied from interface: javax.xml.stream.events.DTD

Returns an implementation defined representation of the DTD. This method may return null if no representation is available.

Specified by:

getProcessedDTD in interface javax.xml.stream.events.DTD

getDocumentTypeDeclaration

public java.lang.String getDocumentTypeDeclaration()

Description copied from interface: javax.xml.stream.events.DTD

Returns the entire Document Type Declaration as a string, including the internal DTD subset. This may be null if there is not an internal subset. If it is not null it must return the entire Document Type Declaration which matches the doctypedecl production in the XML 1.0 specification

Specified by:

getDocumentTypeDeclaration in interface javax.xml.stream.events.DTD

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEntities

public java.util.List getEntities()

Description copied from interface: javax.xml.stream.events.DTD

Return a List containing the general entities, both external and internal, declared in the DTD. This list must contain EntityDeclaration events.

Specified by:

getEntities in interface javax.xml.stream.events.DTD

Returns:

an unordered list of EntityDeclaration events

See Also:

EntityDeclaration

getNotations

public java.util.List getNotations()

Description copied from interface: javax.xml.stream.events.DTD

Return a List containing the notations declared in the DTD. This list must contain NotationDeclaration events.

Specified by:

getNotations in interface javax.xml.stream.events.DTD

Returns:

an unordered list of NotationDeclaration events

See Also:

NotationDeclaration