org.codehaus.stax2.DTDInfo Maven / Gradle / Ivy
package org.codehaus.stax2;
import 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.
*/
public interface DTDInfo
{
// // // Stax2, v1.0
/**
* @return 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.
*/
public Object getProcessedDTD();
/**
* @return If current event is DTD, returns the full root name
* (including prefix, if any); otherwise returns null
*/
public String getDTDRootName();
/**
* @return If current event is DTD, and has a system id, returns the
* system id; otherwise returns null.
*/
public String getDTDSystemId();
/**
* @return If current event is DTD, and has a public id, returns the
* public id; otherwise returns null.
*/
public String getDTDPublicId();
/**
* @return If current event is DTD, and has an internal subset,
* returns the internal subset; otherwise returns null.
*/
public String getDTDInternalSubset();
// // // Stax2, v2.0
/**
* Method similar to {@link #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).
*/
public DTDValidationSchema getProcessedDTDSchema();
}