org.apache.xerces.impl
public class XMLErrorReporter extends Object implements XMLComponent
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:
Version: $Id: XMLErrorReporter.java,v 1.16 2005/06/24 17:56:41 mrglavas Exp $
Field Summary | |
---|---|
protected static String | CONTINUE_AFTER_FATAL_ERROR Feature identifier: continue after fatal error. |
protected static String | ERROR_HANDLER Property identifier: error handler. |
protected boolean | fContinueAfterFatalError Continue after fatal error feature. |
protected XMLErrorHandler | fDefaultErrorHandler
Default error handler. |
protected XMLErrorHandler | fErrorHandler Error handler. |
protected Locale | fLocale The locale to be used to format error messages. |
protected XMLLocator | fLocator Document locator. |
protected Hashtable | fMessageFormatters Mapping of Message formatters for domains. |
static short | SEVERITY_ERROR
Severity: error. |
static short | SEVERITY_FATAL_ERROR
Severity: fatal error. |
static short | SEVERITY_WARNING
Severity: warning. |
Constructor Summary | |
---|---|
XMLErrorReporter() Constructs an error reporter with a locator. |
Method Summary | |
---|---|
XMLErrorHandler | getErrorHandler()
Get the internal XMLErrrorHandler. |
boolean | getFeature(String featureId) |
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.
|
Locale | getLocale()
Gets the current locale.
|
MessageFormatter | getMessageFormatter(String domain)
Returns the message formatter associated with the specified domain,
or null if no message formatter is registered for that domain.
|
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.
|
String[] | getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by
this component. |
String[] | getRecognizedProperties()
Returns a list of property identifiers that are recognized by
this component. |
ErrorHandler | getSAXErrorHandler()
Gets the internal XMLErrorHandler
as SAX ErrorHandler. |
void | putMessageFormatter(String domain, MessageFormatter messageFormatter)
Registers a message formatter for the specified domain.
|
MessageFormatter | removeMessageFormatter(String domain)
Removes the message formatter for the specified domain and
returns the removed message formatter.
|
void | reportError(String domain, String key, Object[] arguments, short severity)
Reports an error. |
void | reportError(XMLLocator location, String domain, String key, Object[] arguments, short severity)
Reports an error at a specific location.
|
void | reset(XMLComponentManager componentManager)
Resets the component. |
void | setDocumentLocator(XMLLocator locator)
Sets the document locator.
|
void | setFeature(String featureId, boolean state)
Sets the state of a feature. |
void | setLocale(Locale locale)
Sets the current locale.
|
void | setProperty(String propertyId, Object value)
Sets the value of a property. |
Note: The parser does have a "continue after fatal error" feature but it should be used with extreme caution and care.
Parameters: featureId The feature identifier.
Since: Xerces 2.2.0
Returns: the current Locale
Parameters: domain The domain of the message formatter.
Parameters: propertyId The property identifier.
Since: Xerces 2.2.0
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 messageFormatter
Parameters: domain The domain of the message formatter.
Parameters: domain The error domain. key The key of the error message. arguments The replacement arguments for the error message, if needed. severity The severity of the error.
See Also: SEVERITY_WARNING SEVERITY_ERROR SEVERITY_FATAL_ERROR
Parameters: location The error location. domain The error domain. key The key of the error message. arguments The replacement arguments for the error message, if needed. severity The severity of the error.
See Also: SEVERITY_WARNING SEVERITY_ERROR SEVERITY_FATAL_ERROR
Parameters: componentManager The component manager.
Throws: SAXException Thrown by component on initialization error. For example, if a feature or property is required for the operation of the component, the component manager may throw a SAXNotRecognizedException or a SAXNotSupportedException.
Parameters: locator The locator.
Note: Components should silently ignore features that do not affect the operation of the component.
Parameters: featureId The feature identifier. state The state of the feature.
Throws: SAXNotRecognizedException The component should not throw this exception. SAXNotSupportedException The component should not throw this exception.
Parameters: locale The new locale.
Note: Components should silently ignore properties that do not affect the operation of the component.
Parameters: propertyId The property identifier. value The value of the property.
Throws: SAXNotRecognizedException The component should not throw this exception. SAXNotSupportedException The component should not throw this exception.