Top Description Methods
org.codehaus.stax2

public Interface DTDInfo

Known Direct Implementers
org.codehaus.stax2.ri.Stax2ReaderAdapter, org.codehaus.stax2.ri.Stax2ReaderImpl, org.codehaus.stax2.ri.dom.DOMWrappingReader
Imports
org.codehaus.stax2.validation.DTDValidationSchema

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

Modifier and TypeMethod and Description
public String

Returns:

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

public String

Returns:

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

public String

Returns:

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

public String

Returns:

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

public Object

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.
getProcessedDTD
()

public DTDValidationSchema
getProcessedDTDSchema()

Method similar to getProcessedDTD, but type-safe.

Method Detail

getDTDInternalSubsetback to summary
public String getDTDInternalSubset()
Returns:String

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

getDTDPublicIdback to summary
public String getDTDPublicId()
Returns:String

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

getDTDRootNameback to summary
public String getDTDRootName()
Returns:String

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

getDTDSystemIdback to summary
public String getDTDSystemId()
Returns:String

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

getProcessedDTDback to summary
public Object getProcessedDTD()
Returns:Object

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.

getProcessedDTDSchemaback to summary
public 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).