Class DTDEvent

java.lang.Object

com.bea.xml.stream.events.BaseEvent

com.bea.xml.stream.events.DTDEvent

All Implemented Interfaces:

DTD, XMLEvent, Location, XMLStreamConstants

public class DTDEvent
extends BaseEvent
implements DTD

Field Summary

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

Constructors

Constructor	Description
DTDEvent()
DTDEvent(String dtd)

Method Summary

Modifier and Type	Method	Description
static EntityDeclaration	createEntityDeclaration(com.wutka.dtd.DTDEntity dtdEntity)
static NotationDeclaration	createNotationDeclaration(com.wutka.dtd.DTDNotation dtdNotation)
protected void	doWriteAsEncodedUnicode(Writer writer)	Template method to be implemented by sub-classes.
String	getDocumentTypeDeclaration()	Returns the entire Document Type Declaration as a string, including the internal DTD subset.
List	getEntities()	Return a List containing the general entities, both external and internal, declared in the DTD.
List	getNotations()	Return a List containing the notations declared in the DTD.
Object	getProcessedDTD()	Returns an implementation defined representation of the DTD.
protected void	init()
void	setDTD(String dtd)
void	setEntities(List l)
void	setNotations(List l)

Methods inherited from class 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, toString, writeAsEncodedUnicode

Methods inherited from class Object

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

Methods inherited from interface XMLEvent

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

Constructor Details

DTDEvent

public DTDEvent()

DTDEvent

public DTDEvent(String dtd)

Method Details

init

protected void init()

createEntityDeclaration

public static EntityDeclaration createEntityDeclaration(com.wutka.dtd.DTDEntity dtdEntity)

createNotationDeclaration

public static NotationDeclaration createNotationDeclaration(com.wutka.dtd.DTDNotation dtdNotation)

setDTD

public void setDTD(String dtd)

setNotations

public void setNotations(List l)

setEntities

public void setEntities(List l)

getProcessedDTD

public 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 DTD

getDocumentTypeDeclaration

public 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 DTD

getEntities

public 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 DTD

Returns:

an unordered list of EntityDeclaration events

See Also:

• EntityDeclaration

getNotations

public 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 DTD

Returns:

an unordered list of NotationDeclaration events

See Also:

• NotationDeclaration

doWriteAsEncodedUnicode

protected void doWriteAsEncodedUnicode(Writer writer)
                                throws IOException

Description copied from class: BaseEvent

Template method to be implemented by sub-classes.

Specified by:

doWriteAsEncodedUnicode in class BaseEvent

Throws:

IOException