Top Description Fields Constructors Methods
com.sun.msv.driver.textui

public Class DebugController

extends Object
implements GrammarReaderController
Class Inheritance
All Implemented Interfaces
com.sun.msv.reader.GrammarReaderController, org.xml.sax.EntityResolver
Imports
java.io.PrintStream, org.xml.sax.EntityResolver, .InputSource, .Locator, .SAXException, com.sun.msv.reader.GrammarReaderController

GrammarReaderController that prints all errors and warnings.
Author
Kohsuke KAWAGUCHI

Field Summary

Modifier and TypeField and Description
private boolean
displayWarning

if true, warnings are reported.

public EntityResolver
externalEntityResolver

entity resolution is delegated to this object.

protected PrintStream
out

messages are sent to this object.

private boolean
warningReported

set to true after "there are warnings..." message is once printed.

Constructor Summary

AccessConstructor and Description
public
DebugController(boolean displayWarning)

public
DebugController(boolean displayWarning, boolean quiet)

public
DebugController(boolean displayWarning, boolean quiet, EntityResolver externalEntityResolver)

public
DebugController(boolean displayWarning, boolean quiet, PrintStream outDevice)

public
DebugController(boolean displayWarning, boolean quiet, PrintStream outDevice, EntityResolver externalEntityResolver)

Method Summary

Modifier and TypeMethod and Description
public void
error(Locator[] loc, String errorMessage, Exception nestedException)

Implements com.sun.msv.reader.GrammarReaderController.error.

private void
public InputSource
resolveEntity(String
The public identifier of the external entity being referenced, or null if none was supplied.
publicId
,
String
The system identifier of the external entity being referenced.
systemId
)

Implements org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

displayWarningback to summary
private boolean displayWarning

if true, warnings are reported. If false, not reported.

externalEntityResolverback to summary
public EntityResolver externalEntityResolver

entity resolution is delegated to this object. can be null.

outback to summary
protected PrintStream out

messages are sent to this object.

warningReportedback to summary
private boolean warningReported

set to true after "there are warnings..." message is once printed.

Constructor Detail

DebugControllerback to summary
public DebugController(boolean displayWarning)
DebugControllerback to summary
public DebugController(boolean displayWarning, boolean quiet)
DebugControllerback to summary
public DebugController(boolean displayWarning, boolean quiet, EntityResolver externalEntityResolver)
DebugControllerback to summary
public DebugController(boolean displayWarning, boolean quiet, PrintStream outDevice)
DebugControllerback to summary
public DebugController(boolean displayWarning, boolean quiet, PrintStream outDevice, EntityResolver externalEntityResolver)

Method Detail

errorback to summary
public void error(Locator[] loc, String errorMessage, Exception nestedException)

Implements com.sun.msv.reader.GrammarReaderController.error.

printLocationback to summary
private void printLocation(Locator loc)
resolveEntityback to summary
public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException

Implements org.xml.sax.EntityResolver.resolveEntity.

Doc from org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.

The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream).

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL.

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Parameters
publicId:String

The public identifier of the external entity being referenced, or null if none was supplied.

systemId:String

The system identifier of the external entity being referenced.

Returns:InputSource

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

Exceptions
IOException:
A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.
SAXException:
Any SAX exception, possibly wrapping another exception.
warningback to summary
public void warning(Locator[] loc, String errorMessage)

Implements com.sun.msv.reader.GrammarReaderController.warning.