DTD (Java SE 25 & JDK 25)
Description: declaration: module: java.xml, package: javax.xml.stream.events, interface: DTD
Keywords: javax.xml.stream.events.DTD interface

# Interface DTD

All Superinterfaces:
  `XMLEvent, XMLStreamConstants`

public interface DTD extends XMLEvent
This is the top level interface for events dealing with DTDs

Since:
  1.6

- ## Field Summary

  ### Fields declared in 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`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getDocumentTypeDeclaration()`
  Returns the entire Document Type Declaration as a string, including the internal DTD subset.
  `List<EntityDeclaration>`
  `getEntities()`
  Return a List containing the general entities, both external and internal, declared in the DTD.
  `List<NotationDeclaration>`
  `getNotations()`
  Return a List containing the notations declared in the DTD.
  `Object`
  `getProcessedDTD()`
  Returns an implementation defined representation of the DTD.

  ### Methods declared in interface XMLEvent

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

- ## Method Details

  - ### 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
    Returns:
      the Document Type Declaration

  - ### getProcessedDTD

    Object getProcessedDTD()
    Returns an implementation defined representation of the DTD. This method may return null if no representation is available.
    Returns:
      the representation of the DTD

  - ### getNotations

    List<NotationDeclaration> 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<EntityDeclaration> 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`