Home » Xerces-J-src.2.9.1 » org.apache.xerces » impl » [javadoc | source]
org.apache.xerces.impl
public class: XMLErrorReporter [javadoc | source]
java.lang.Object
   org.apache.xerces.impl.XMLErrorReporter

All Implemented Interfaces:
    XMLComponent

This class is a common element of all parser configurations and is used to report errors that occur. This component can be queried by parser components from the component manager using the following property ID:
http://apache.org/xml/properties/internal/error-reporter

Errors are separated into domains that categorize a class of errors. In a parser configuration, the parser would register a MessageFormatter for each domain that is capable of localizing error messages and formatting them based on information about the error. Any parser component can invent new error domains and register additional message formatters to localize messages in those domains.

This component requires the following features and properties from the component manager that uses it:

This component can use the following features and properties but they are not required:

Field Summary
public static final  short SEVERITY_WARNING    Severity: warning. Warnings represent informational messages only that should not be considered serious enough to stop parsing or indicate an error in the document's validity. 
public static final  short SEVERITY_ERROR    Severity: error. Common causes of errors are document structure and/or content that that does not conform to the grammar rules specified for the document. These are typically validation errors. 
public static final  short SEVERITY_FATAL_ERROR    Severity: fatal error. Fatal errors are errors in the syntax of the XML document or invalid byte sequences for a given encoding. The XML 1.0 Specification mandates that errors of this type are not recoverable.

Note: The parser does have a "continue after fatal error" feature but it should be used with extreme caution and care. 

protected static final  String CONTINUE_AFTER_FATAL_ERROR    Feature identifier: continue after fatal error. 
protected static final  String ERROR_HANDLER    Property identifier: error handler. 
protected  Locale fLocale    The locale to be used to format error messages. 
protected  Hashtable fMessageFormatters    Mapping of Message formatters for domains. 
protected  XMLErrorHandler fErrorHandler    Error handler. 
protected  XMLLocator fLocator    Document locator. 
protected  boolean fContinueAfterFatalError    Continue after fatal error feature. 
protected  XMLErrorHandler fDefaultErrorHandler    Default error handler. This error handler is only used in the absence of a registered error handler so that errors are not "swallowed" silently. This is one of the most common "problems" reported by users of the parser. 
Constructor:
 public XMLErrorReporter() 
Method from org.apache.xerces.impl.XMLErrorReporter Summary:
getErrorHandler,   getFeature,   getFeatureDefault,   getLocale,   getMessageFormatter,   getPropertyDefault,   getRecognizedFeatures,   getRecognizedProperties,   getSAXErrorHandler,   putMessageFormatter,   removeMessageFormatter,   reportError,   reportError,   reportError,   reportError,   reset,   setDocumentLocator,   setFeature,   setLocale,   setProperty
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xerces.impl.XMLErrorReporter Detail:
 public XMLErrorHandler getErrorHandler() 
    Get the internal XMLErrrorHandler.
 public boolean getFeature(String featureId) throws XMLConfigurationException 
 public Boolean getFeatureDefault(String featureId) 
    Returns the default state for a feature, or null if this component does not want to report a default value for this feature.
 public Locale getLocale() 
    Gets the current locale.
 public MessageFormatter getMessageFormatter(String domain) 
    Returns the message formatter associated with the specified domain, or null if no message formatter is registered for that domain.
 public Object getPropertyDefault(String propertyId) 
    Returns the default state for a property, or null if this component does not want to report a default value for this property.
 public String[] getRecognizedFeatures() 
    Returns a list of feature identifiers that are recognized by this component. This method may return null if no features are recognized by this component.
 public String[] getRecognizedProperties() 
    Returns a list of property identifiers that are recognized by this component. This method may return null if no properties are recognized by this component.
 public ErrorHandler getSAXErrorHandler() 
    Gets the internal XMLErrorHandler as SAX ErrorHandler.
 public  void putMessageFormatter(String domain,
    MessageFormatter messageFormatter) 
    Registers a message formatter for the specified domain.

    Note: Registering a message formatter for a domain when there is already a formatter registered will cause the previous formatter to be lost. This method replaces any previously registered message formatter for the specified domain.

 public MessageFormatter removeMessageFormatter(String domain) 
    Removes the message formatter for the specified domain and returns the removed message formatter.
 public  void reportError(String domain,
    String key,
    Object[] arguments,
    short severity) throws XNIException 
    Reports an error. The error message passed to the error handler is formatted for the locale by the message formatter installed for the specified error domain.
 public  void reportError(String domain,
    String key,
    Object[] arguments,
    short severity,
    Exception exception) throws XNIException 
    Reports an error. The error message passed to the error handler is formatted for the locale by the message formatter installed for the specified error domain.
 public  void reportError(XMLLocator location,
    String domain,
    String key,
    Object[] arguments,
    short severity) throws XNIException 
    Reports an error at a specific location.
 public  void reportError(XMLLocator location,
    String domain,
    String key,
    Object[] arguments,
    short severity,
    Exception exception) throws XNIException 
    Reports an error at a specific location.
 public  void reset(XMLComponentManager componentManager) throws XNIException 
    Resets the component. The component can query the component manager about any features and properties that affect the operation of the component.
 public  void setDocumentLocator(XMLLocator locator) 
    Sets the document locator.
 public  void setFeature(String featureId,
    boolean state) throws XMLConfigurationException 
    Sets the state of a feature. This method is called by the component manager any time after reset when a feature changes state.

    Note: Components should silently ignore features that do not affect the operation of the component.

 public  void setLocale(Locale locale) 
    Sets the current locale.
 public  void setProperty(String propertyId,
    Object value) throws XMLConfigurationException 
    Sets the value of a property. This method is called by the component manager any time after reset when a property changes value.

    Note: Components should silently ignore properties that do not affect the operation of the component.