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

All Superinterfaces:: XMLEvent, XMLStreamConstants

public interface DTD
extends XMLEvent

This is the top level interface for events dealing with DTDs

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`	`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.

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

getDocumentTypeDeclaration

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

getEntities

public List getEntities()

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

Returns:: an unordered list of EntityDeclaration events

getNotations

public List getNotations()

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

Returns:: an unordered list of NotationDeclaration events

getProcessedDTD

public Object getProcessedDTD()

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