org.codehaus.stax2
Interface DTDInfo

All Known Implementing Classes:

DOMWrappingReader, Stax2ReaderAdapter, Stax2ReaderImpl

public interface DTDInfo

Interface that specifies additional access functionality to parsed DTD information (if any); these methods are encapsulated on a separate interface to keep the main reader interface from exploding.

Note: instances of DTDInfo are not guaranteed to persist when the reader that returned it is asked to provide the next event. Some implementations may let it persist, others might not.

Method Summary

String	getDTDInternalSubset()
String	getDTDPublicId()
String	getDTDRootName()
String	getDTDSystemId()
Object	getProcessedDTD()
DTDValidationSchema	getProcessedDTDSchema() Method similar to getProcessedDTD(), but type-safe.

Method Detail

getProcessedDTD

Object getProcessedDTD()

Returns:

If current event is DTD, DTD support is enabled, and reader supports DTD processing, returns an internal Object implementation uses for storing/processing DTD; otherwise returns null.

getDTDRootName

String getDTDRootName()

Returns:

If current event is DTD, returns the full root name (including prefix, if any); otherwise returns null

getDTDSystemId

String getDTDSystemId()

Returns:

If current event is DTD, and has a system id, returns the system id; otherwise returns null.

getDTDPublicId

String getDTDPublicId()

Returns:

If current event is DTD, and has a public id, returns the public id; otherwise returns null.

getDTDInternalSubset

String getDTDInternalSubset()

Returns:

If current event is DTD, and has an internal subset, returns the internal subset; otherwise returns null.

getProcessedDTDSchema

DTDValidationSchema getProcessedDTDSchema()

Method similar to getProcessedDTD(), but type-safe. Will return the DTD schema instance that was read, if we are in mode where it does get read (at least dtd-aware).