|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.impl.XMLErrorReporter
public class XMLErrorReporter
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:
MessageFormatter
Field Summary | |
---|---|
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(java.lang.String featureId)
|
java.lang.Boolean |
getFeatureDefault(java.lang.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. |
java.util.Locale |
getLocale()
Gets the current locale. |
MessageFormatter |
getMessageFormatter(java.lang.String domain)
Returns the message formatter associated with the specified domain, or null if no message formatter is registered for that domain. |
java.lang.Object |
getPropertyDefault(java.lang.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. |
java.lang.String[] |
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component. |
java.lang.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(java.lang.String domain,
MessageFormatter messageFormatter)
Registers a message formatter for the specified domain. |
MessageFormatter |
removeMessageFormatter(java.lang.String domain)
Removes the message formatter for the specified domain and returns the removed message formatter. |
void |
reportError(java.lang.String domain,
java.lang.String key,
java.lang.Object[] arguments,
short severity)
Reports an error. |
void |
reportError(java.lang.String domain,
java.lang.String key,
java.lang.Object[] arguments,
short severity,
java.lang.Exception exception)
Reports an error. |
void |
reportError(XMLLocator location,
java.lang.String domain,
java.lang.String key,
java.lang.Object[] arguments,
short severity)
Reports an error at a specific location. |
void |
reportError(XMLLocator location,
java.lang.String domain,
java.lang.String key,
java.lang.Object[] arguments,
short severity,
java.lang.Exception exception)
Reports an error at a specific location. |
void |
reset(XMLComponentManager componentManager)
Resets the component. |
void |
setDocumentLocator(XMLLocator locator)
Sets the document locator. |
void |
setFeature(java.lang.String featureId,
boolean state)
Sets the state of a feature. |
void |
setLocale(java.util.Locale locale)
Sets the current locale. |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
Sets the value of a property. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final short SEVERITY_WARNING
public static final short SEVERITY_ERROR
public static final short SEVERITY_FATAL_ERROR
Note: The parser does have a "continue after fatal error" feature but it should be used with extreme caution and care.
Constructor Detail |
---|
public XMLErrorReporter()
Method Detail |
---|
public void setLocale(java.util.Locale locale)
locale
- The new locale.public java.util.Locale getLocale()
public void setDocumentLocator(XMLLocator locator)
locator
- The locator.public void putMessageFormatter(java.lang.String domain, MessageFormatter messageFormatter)
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.
domain
- messageFormatter
- public MessageFormatter getMessageFormatter(java.lang.String domain)
domain
- The domain of the message formatter.public MessageFormatter removeMessageFormatter(java.lang.String domain)
domain
- The domain of the message formatter.public void reportError(java.lang.String domain, java.lang.String key, java.lang.Object[] arguments, short severity) throws XNIException
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.
XNIException
SEVERITY_WARNING
,
SEVERITY_ERROR
,
SEVERITY_FATAL_ERROR
public void reportError(java.lang.String domain, java.lang.String key, java.lang.Object[] arguments, short severity, java.lang.Exception exception) throws XNIException
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.exception
- The exception to wrap.
XNIException
SEVERITY_WARNING
,
SEVERITY_ERROR
,
SEVERITY_FATAL_ERROR
public void reportError(XMLLocator location, java.lang.String domain, java.lang.String key, java.lang.Object[] arguments, short severity) throws XNIException
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.
XNIException
SEVERITY_WARNING
,
SEVERITY_ERROR
,
SEVERITY_FATAL_ERROR
public void reportError(XMLLocator location, java.lang.String domain, java.lang.String key, java.lang.Object[] arguments, short severity, java.lang.Exception exception) throws XNIException
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.exception
- The exception to wrap.
XNIException
SEVERITY_WARNING
,
SEVERITY_ERROR
,
SEVERITY_FATAL_ERROR
public void reset(XMLComponentManager componentManager) throws XNIException
reset
in interface XMLComponent
componentManager
- The component manager.
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.
XNIException
- Thrown by component on initialization error.public java.lang.String[] getRecognizedFeatures()
getRecognizedFeatures
in interface XMLComponent
public void setFeature(java.lang.String featureId, boolean state) throws XMLConfigurationException
Note: Components should silently ignore features that do not affect the operation of the component.
setFeature
in interface XMLComponent
featureId
- The feature identifier.state
- The state of the feature.
SAXNotRecognizedException
- The component should not throw
this exception.
SAXNotSupportedException
- The component should not throw
this exception.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public boolean getFeature(java.lang.String featureId) throws XMLConfigurationException
XMLConfigurationException
public java.lang.String[] getRecognizedProperties()
getRecognizedProperties
in interface XMLComponent
public void setProperty(java.lang.String propertyId, java.lang.Object value) throws XMLConfigurationException
Note: Components should silently ignore properties that do not affect the operation of the component.
setProperty
in interface XMLComponent
propertyId
- The property identifier.value
- The value of the property.
SAXNotRecognizedException
- The component should not throw
this exception.
SAXNotSupportedException
- The component should not throw
this exception.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.public java.lang.Boolean getFeatureDefault(java.lang.String featureId)
getFeatureDefault
in interface XMLComponent
featureId
- The feature identifier.public java.lang.Object getPropertyDefault(java.lang.String propertyId)
getPropertyDefault
in interface XMLComponent
propertyId
- The property identifier.public XMLErrorHandler getErrorHandler()
public ErrorHandler getSAXErrorHandler()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |