DTD (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

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
extends XMLEvent

This is the top level interface for events dealing with DTDs

Version:: 1.0
Author:: Copyright (c) 2003 by BEA Systems. All Rights Reserved.

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

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 interface javax.xml.stream.events.XMLEvent

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

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`

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 interface javax.xml.stream.events.XMLEvent
`asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode`

Method Detail

getDocumentTypeDeclaration

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

getProcessedDTD

Object getProcessedDTD()

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

getNotations

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
See Also:: NotationDeclaration

getEntities

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
See Also:: EntityDeclaration