| java.lang.Object
 com.sun.xml.stream.XMLErrorReporter
All known Subclasses: com.sun.xml.stream.StaxErrorReporter,
| XMLErrorReporter | | public class XMLErrorReporter implements XMLComponent(Code) | | 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:
- http://apache.org/xml/properties/internal/error-handler
This component can use the following features and properties but they
are not required:
- http://apache.org/xml/features/continue-after-fatal-error
See Also: MessageFormatter
author:
Eric Ye, IBM
author:
Andy Clark, IBM
version:
$Id: XMLErrorReporter.java,v 1.2 2006/04/01 06:01:49 jeffsuttor Exp $ |
| Constructor Summary | |
| public | XMLErrorReporter()
Constructs an error reporter with a locator. |
| Method Summary | |
| public XMLErrorHandler | getErrorHandler()
Get the internal XMLErrrorHandler. | | public boolean | getFeature(String featureId)
| | 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. | | public String[] | getRecognizedProperties()
Returns a list of property identifiers that are recognized by
this component. | | 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. | | 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)
Reports an error. | | public void | reportError(XMLLocator location, String domain, String key, Object[] arguments, short severity)
Reports an error at a specific location. | | public void | reset(XMLComponentManager componentManager)
Resets the component. | | public void | setDocumentLocator(XMLLocator locator)
Sets the document locator. | | public void | setFeature(String featureId, boolean state)
Sets the state of a feature. | | public void | setLocale(Locale locale)
Sets the current locale. | | public void | setProperty(String propertyId, Object value)
Sets the value of a property. |
| CONTINUE_AFTER_FATAL_ERROR | | final protected static String CONTINUE_AFTER_FATAL_ERROR(Code) | | Feature identifier: continue after fatal error.
|
| ERROR_HANDLER | | final protected static String ERROR_HANDLER(Code) | | Property identifier: error handler.
|
| SEVERITY_ERROR | | final public static short SEVERITY_ERROR(Code) | | 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.
|
| SEVERITY_FATAL_ERROR | | final public static short SEVERITY_FATAL_ERROR(Code) | | 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.
|
| SEVERITY_WARNING | | final public static short SEVERITY_WARNING(Code) | | 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.
|
| fContinueAfterFatalError | | protected boolean fContinueAfterFatalError(Code) | | Continue after fatal error feature.
|
| fDefaultErrorHandler | | protected XMLErrorHandler fDefaultErrorHandler(Code) | | 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.
|
| fLocale | | protected Locale fLocale(Code) | | The locale to be used to format error messages.
|
| fMessageFormatters | | protected Hashtable fMessageFormatters(Code) | | Mapping of Message formatters for domains.
|
| XMLErrorReporter | | public XMLErrorReporter()(Code) | | Constructs an error reporter with a locator.
|
| getFeatureDefault | | public Boolean getFeatureDefault(String featureId)(Code) | | Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
Parameters:
featureId - The feature identifier.
since:
Xerces 2.2.0 |
| getLocale | | public Locale getLocale()(Code) | | Gets the current locale.
the current Locale |
| getMessageFormatter | | public MessageFormatter getMessageFormatter(String domain)(Code) | | Returns the message formatter associated with the specified domain,
or null if no message formatter is registered for that domain.
Parameters:
domain - The domain of the message formatter. |
| getPropertyDefault | | public Object getPropertyDefault(String propertyId)(Code) | | Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
Parameters:
propertyId - The property identifier.
since:
Xerces 2.2.0 |
| getRecognizedFeatures | | public String[] getRecognizedFeatures()(Code) | | 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.
|
| getRecognizedProperties | | public String[] getRecognizedProperties()(Code) | | 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.
|
| putMessageFormatter | | public void putMessageFormatter(String domain, MessageFormatter messageFormatter)(Code) | | 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.
Parameters:
domain -
Parameters:
messageFormatter - |
| removeMessageFormatter | | public MessageFormatter removeMessageFormatter(String domain)(Code) | | Removes the message formatter for the specified domain and
returns the removed message formatter.
Parameters:
domain - The domain of the message formatter. |
| reset | | public void reset(XMLComponentManager componentManager) throws XNIException(Code) | | Resets the component. The component can query the component manager
about any features and properties that affect the operation of the
component.
Parameters:
componentManager - The component manager.
throws:
SAXException - Thrown by component on initialization error.For example, if a feature or property isrequired for the operation of the component, thecomponent manager may throw aSAXNotRecognizedException or aSAXNotSupportedException. |
| setDocumentLocator | | public void setDocumentLocator(XMLLocator locator)(Code) | | Sets the document locator.
Parameters:
locator - The locator. |
| setFeature | | public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code) | | 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.
Parameters:
featureId - The feature identifier.
Parameters:
state - The state of the feature.
throws:
SAXNotRecognizedException - The component should not throwthis exception.
throws:
SAXNotSupportedException - The component should not throwthis exception. |
| setLocale | | public void setLocale(Locale locale)(Code) | | Sets the current locale.
Parameters:
locale - The new locale. |
| setProperty | | public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code) | | 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.
Parameters:
propertyId - The property identifier.
Parameters:
value - The value of the property.
throws:
SAXNotRecognizedException - The component should not throwthis exception.
throws:
SAXNotSupportedException - The component should not throwthis exception. |
|
|