Package org.codehaus.stax2.ri.evt

Class DTDEventImpl

java.lang.Object

org.codehaus.stax2.ri.evt.BaseEventImpl

org.codehaus.stax2.ri.evt.DTDEventImpl

All Implemented Interfaces:

javax.xml.stream.events.DTD, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants, DTD2, XMLEvent2

public class DTDEventImpl
extends BaseEventImpl
implements DTD2

Vanilla implementation of a DTD event. Note that as is, it is not really complete, since there is no way to access declared notations and entities, because Stax 1.0 has no method for dispatching calls. As such, it is expected that actual implementations would usually extend this class, instead of using it as is.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Object	mDTD
protected java.lang.String	mFullText	Full textual presentation of the DOCTYPE event; usually only constructed when needed, but sometimes (when using 'broken' older StAX interfaces), may be the only piece that's actually passed.
protected java.lang.String	mInternalSubset
protected java.lang.String	mPublicId
protected java.lang.String	mRootName
protected java.lang.String	mSystemId

Fields inherited from class org.codehaus.stax2.ri.evt.BaseEventImpl

mLocation

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

Constructors

Constructor	Description
DTDEventImpl(javax.xml.stream.Location loc, java.lang.String fullText)
DTDEventImpl(javax.xml.stream.Location loc, java.lang.String rootName, java.lang.String intSubset)	Constructor used when only partial information is available.
DTDEventImpl(javax.xml.stream.Location loc, java.lang.String rootName, java.lang.String sysId, java.lang.String pubId, java.lang.String intSubset, java.lang.Object dtd)

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	doGetDocumentTypeDeclaration()
boolean	equals(java.lang.Object o)	Declared abstract to force redefinition by sub-classes
java.lang.String	getDocumentTypeDeclaration()
java.util.List<javax.xml.stream.events.EntityDeclaration>	getEntities()
int	getEventType()
java.lang.String	getInternalSubset()
java.util.List<javax.xml.stream.events.NotationDeclaration>	getNotations()
java.lang.Object	getProcessedDTD()
java.lang.String	getPublicId()
java.lang.String	getRootName()
java.lang.String	getSystemId()
int	hashCode()	Declared abstract to force redefinition by sub-classes
void	writeAsEncodedUnicode(java.io.Writer w)
void	writeUsing(XMLStreamWriter2 w)

Methods inherited from class org.codehaus.stax2.ri.evt.BaseEventImpl

addHash, asCharacters, asEndElement, asStartElement, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, iteratedEquals, stringsWithNullsEqual, throwFromIOE, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

mRootName

protected final java.lang.String mRootName

mSystemId

protected final java.lang.String mSystemId

mPublicId

protected final java.lang.String mPublicId

mInternalSubset

protected final java.lang.String mInternalSubset

mDTD

protected final java.lang.Object mDTD

mFullText

protected java.lang.String mFullText

Full textual presentation of the DOCTYPE event; usually only constructed when needed, but sometimes (when using 'broken' older StAX interfaces), may be the only piece that's actually passed.

Constructor Detail

DTDEventImpl

public DTDEventImpl(javax.xml.stream.Location loc,
                    java.lang.String rootName,
                    java.lang.String sysId,
                    java.lang.String pubId,
                    java.lang.String intSubset,
                    java.lang.Object dtd)

DTDEventImpl

public DTDEventImpl(javax.xml.stream.Location loc,
                    java.lang.String rootName,
                    java.lang.String intSubset)

Constructor used when only partial information is available.

DTDEventImpl

public DTDEventImpl(javax.xml.stream.Location loc,
                    java.lang.String fullText)

Method Detail

getDocumentTypeDeclaration

public java.lang.String getDocumentTypeDeclaration()

Specified by:

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

getEntities

public java.util.List<javax.xml.stream.events.EntityDeclaration> getEntities()

Specified by:

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

getNotations

public java.util.List<javax.xml.stream.events.NotationDeclaration> getNotations()

Specified by:

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

getProcessedDTD

public java.lang.Object getProcessedDTD()

Specified by:

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

getEventType

public int getEventType()

Specified by:

getEventType in interface javax.xml.stream.events.XMLEvent

Specified by:

getEventType in class BaseEventImpl

writeAsEncodedUnicode

public void writeAsEncodedUnicode(java.io.Writer w)
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeAsEncodedUnicode in interface javax.xml.stream.events.XMLEvent

Specified by:

writeAsEncodedUnicode in class BaseEventImpl

Throws:

javax.xml.stream.XMLStreamException

writeUsing

public void writeUsing(XMLStreamWriter2 w)
                throws javax.xml.stream.XMLStreamException

Specified by:

writeUsing in interface XMLEvent2

Specified by:

writeUsing in class BaseEventImpl

Throws:

javax.xml.stream.XMLStreamException

getRootName

public java.lang.String getRootName()

Specified by:

getRootName in interface DTD2

getSystemId

public java.lang.String getSystemId()

Specified by:

getSystemId in interface DTD2

getPublicId

public java.lang.String getPublicId()

Specified by:

getPublicId in interface DTD2

getInternalSubset

public java.lang.String getInternalSubset()

Specified by:

getInternalSubset in interface DTD2

equals

public boolean equals(java.lang.Object o)

Description copied from class: BaseEventImpl

Declared abstract to force redefinition by sub-classes

Specified by:

equals in class BaseEventImpl

hashCode

public int hashCode()

Description copied from class: BaseEventImpl

Declared abstract to force redefinition by sub-classes

Specified by:

hashCode in class BaseEventImpl

doGetDocumentTypeDeclaration

protected java.lang.String doGetDocumentTypeDeclaration()
                                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException