APIdia Launch Partner
Top Fields Constructors Methods
com.sun.xml.internal.stream.events

public Class DTDEvent

extends DummyEvent
implements DTD
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.DTD, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
java.util.List, javax.xml.stream.events.DTD, .EntityDeclaration, .NotationDeclaration, .XMLEvent

Author
Neeraj Bajaj, Sun Microsystesm.

Field Summary

Modifier and TypeField and Description
private String
private List<EntityDeclaration>
private List<NotationDeclaration>
Inherited from com.sun.xml.internal.stream.events.DummyEvent:
fLocation

Constructor Summary

AccessConstructor and Description
public
DTDEvent()

Creates a new instance of DTDEvent

public
DTDEvent(String doctypeDeclaration)

Method Summary

Modifier and TypeMethod and Description
public String
getDocumentTypeDeclaration()

Implements javax.xml.stream.events.DTD.getDocumentTypeDeclaration.

Returns the entire Document Type Declaration as a string, including the internal DTD subset.

public List<EntityDeclaration>
getEntities()

Implements javax.xml.stream.events.DTD.getEntities.

Return a List containing the general entities, both external and internal, declared in the DTD.

public List<NotationDeclaration>
getNotations()

Implements javax.xml.stream.events.DTD.getNotations.

Return a List containing the notations declared in the DTD.

public Object
getProcessedDTD()

Implements javax.xml.stream.events.DTD.getProcessedDTD.

Returns an implementation defined representation of the DTD.

protected final void
init()

public void
setDocumentTypeDeclaration(String doctypeDeclaration)

public void
public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected void
writeAsEncodedUnicodeEx(Writer writer)

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
asCharactersasEndElementasStartElementcharEncodegetEventTypegetLocationgetSchemaTypeisAttributeisCharacterDataisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementsetEventTypesetLocationwriteAsEncodedUnicode

Field Detail

fDoctypeDeclarationback to summary
private String fDoctypeDeclaration
fEntitiesback to summary
private List<EntityDeclaration> fEntities
fNotationsback to summary
private List<NotationDeclaration> fNotations

Constructor Detail

DTDEventback to summary
public DTDEvent()

Creates a new instance of DTDEvent

DTDEventback to summary
public DTDEvent(String doctypeDeclaration)

Method Detail

getDocumentTypeDeclarationback to summary
public String getDocumentTypeDeclaration()

Implements javax.xml.stream.events.DTD.getDocumentTypeDeclaration.

Doc from javax.xml.stream.events.DTD.getDocumentTypeDeclaration.

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

Annotations
@Override
getEntitiesback to summary
public List<EntityDeclaration> getEntities()

Implements javax.xml.stream.events.DTD.getEntities.

Doc from javax.xml.stream.events.DTD.getEntities.

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

Annotations
@Override
getNotationsback to summary
public List<NotationDeclaration> getNotations()

Implements javax.xml.stream.events.DTD.getNotations.

Doc from javax.xml.stream.events.DTD.getNotations.

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

Annotations
@Override
getProcessedDTDback to summary
public Object getProcessedDTD()

Implements javax.xml.stream.events.DTD.getProcessedDTD.

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

Annotations
@Override
initback to summary
protected final void init()
setDocumentTypeDeclarationback to summary
public void setDocumentTypeDeclaration(String doctypeDeclaration)
setEntitiesback to summary
public void setEntities(List<EntityDeclaration> entities)
setNotationsback to summary
public void setNotations(List<NotationDeclaration> notations)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
writeAsEncodedUnicodeExback to summary
protected void writeAsEncodedUnicodeEx(Writer writer) throws IOException

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Doc from com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Annotations
@Override
Exceptions
IOException:
if there is an IO error