JAXB OSGI 4.0.9 · com.sun.tools.xjc.ErrorReceiver · APIdia, the JavaDoc alternative

Implemented by the driver of the compiler engine to handle errors found during the compiliation.

This class implements ErrorHandler so it can be passed to anywhere where ErrorHandler is expected.

However, to make the error handling easy (and make it work with visitor patterns nicely), none of the methods on thi class throws org.xml.sax.SAXException. Instead, when the compilation needs to be aborted, it throws AbortException, which is unchecked.

This also implements the externally visible ErrorListener so that we can reuse our internal implementation for testing and such.

Constructor Summary

Access	Constructor and Description
protected	ErrorReceiver() Default constructor.

Method Summary

Modifier and Type	Method and Description
public final void	debug(String msg) Reports a debug message to users.
public final void	error(Locator can be null if the location is unknown loc, String msg)
public final void	error(Locator loc, String msg, Exception e)
public final void	error(String msg, Exception e)
public void	error(Exception e)
public abstract void	error(SAXParseException exception) Redeclares org.xml.sax.ErrorHandler.error, com.sun.tools.xjc.api.ErrorListener.error. Receive notification of a recoverable error.
public abstract void	fatalError(SAXParseException exception) Redeclares org.xml.sax.ErrorHandler.fatalError, com.sun.tools.xjc.api.ErrorListener.fatalError. Receive notification of a non-recoverable, fatal error.
protected final String	Returns: non-null valid object. getLocationString(SAXParseException e) Returns the human readable string representation of the `org.xml.sax.Locator` part of the specified `SAXParseException`.
private String	getShortName(String url) Computes a short name of a given URL for display.
public abstract void	info(SAXParseException exception) Redeclares com.sun.tools.xjc.api.ErrorListener.info. Reports verbose messages to users.
public void	pollAbort() This method will be invoked periodically to allow `AbortException` to be thrown, especially when this is driven by some kind of GUI.
public final void	warning(Locator can be null if the location is unknown loc, String msg)
public abstract void	warning(SAXParseException exception) Redeclares org.xml.sax.ErrorHandler.warning, com.sun.tools.xjc.api.ErrorListener.warning. Receive notification of a warning.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ErrorReceiver	back to summary
protected ErrorReceiver() Default constructor.

Method Detail

debug back to summary

debug	back to summary
public final void debug(String msg) Reports a debug message to users. See Also `info(SAXParseException)`

public final void debug(String msg)

Reports a debug message to users.

See Also: info(SAXParseException)

error	back to summary
public final void error(Locator loc, String msg) Parameters loc:Locator can be null if the location is unknown

error	back to summary
public final void error(Locator loc, String msg, Exception e)

error	back to summary
public final void error(String msg, Exception e)

error	back to summary
public void error(Exception e)

error	back to summary
public abstract void error(SAXParseException exception) throws AbortException Redeclares org.xml.sax.ErrorHandler.error, com.sun.tools.xjc.api.ErrorListener.error. Doc from org.xml.sax.ErrorHandler.error. Receive notification of a recoverable error. This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so. Filters may use this method to report other, non-XML errors as well. Annotations @Override

error

back to summary

public abstract void error(SAXParseException exception) throws AbortException

Redeclares org.xml.sax.ErrorHandler.error, com.sun.tools.xjc.api.ErrorListener.error.

Doc from org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Annotations

@Override

fatalError	back to summary
public abstract void fatalError(SAXParseException exception) throws AbortException Redeclares org.xml.sax.ErrorHandler.fatalError, com.sun.tools.xjc.api.ErrorListener.fatalError. Doc from org.xml.sax.ErrorHandler.fatalError. Receive notification of a non-recoverable, fatal error. As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation. Annotations @Override

fatalError

back to summary

public abstract void fatalError(SAXParseException exception) throws AbortException

Redeclares org.xml.sax.ErrorHandler.fatalError, com.sun.tools.xjc.api.ErrorListener.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Annotations

@Override

getLocationString back to summary

getLocationString	back to summary
protected final String getLocationString(SAXParseException e) Returns the human readable string representation of the `org.xml.sax.Locator` part of the specified `SAXParseException`. Returns:String non-null valid object.

protected final String getLocationString(SAXParseException e)

Returns the human readable string representation of the org.xml.sax.Locator part of the specified SAXParseException.

Returns:String: non-null valid object.

getShortName	back to summary
private String getShortName(String url) Computes a short name of a given URL for display.

info	back to summary
public abstract void info(SAXParseException exception) Redeclares com.sun.tools.xjc.api.ErrorListener.info. Reports verbose messages to users. This method can be used to report additional non-essential messages. The implementation usually discards them unless some specific debug option is turned on. Annotations @Override

info

back to summary

public abstract void info(SAXParseException exception)

Redeclares com.sun.tools.xjc.api.ErrorListener.info.

Reports verbose messages to users. This method can be used to report additional non-essential messages. The implementation usually discards them unless some specific debug option is turned on.

Annotations

@Override

pollAbort	back to summary
public void pollAbort() throws AbortException This method will be invoked periodically to allow `AbortException` to be thrown, especially when this is driven by some kind of GUI.

warning	back to summary
public final void warning(Locator loc, String msg) Parameters loc:Locator can be null if the location is unknown

warning	back to summary
public abstract void warning(SAXParseException exception) throws AbortException Redeclares org.xml.sax.ErrorHandler.warning, com.sun.tools.xjc.api.ErrorListener.warning. Doc from org.xml.sax.ErrorHandler.warning. Receive notification of a warning. SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action. The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. Filters may use this method to report other, non-XML warnings as well. Annotations @Override

warning

back to summary

public abstract void warning(SAXParseException exception) throws AbortException

Redeclares org.xml.sax.ErrorHandler.warning, com.sun.tools.xjc.api.ErrorListener.warning.

Doc from org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Annotations

@Override

public abstract Class ErrorReceiver

Constructor Summary

Method Summary

Constructor Detail

Method Detail