org.apache.commons.configuration.event
Class ConfigurationErrorEvent
java.lang.Object
java.util.EventObject
org.apache.commons.configuration.event.ConfigurationEvent
org.apache.commons.configuration.event.ConfigurationErrorEvent
- All Implemented Interfaces:
- Serializable
public class ConfigurationErrorEvent
- extends ConfigurationEvent
An event class that is used for reporting errors that occurred while
processing configuration properties.
Some configuration implementations (e.g.
DatabaseConfiguration
or JNDIConfiguration
use an underlying storage that can throw an exception on each property
access. In earlier versions of this library such exceptions were logged and
then silently ignored. This makes it impossible for a client to find out that
something went wrong.
To give clients better control over the handling of errors that occur during
access of a configuration object a new event listener mechanism specific for
exceptions is introduced: Clients can register itself at a configuration
object as an error listener and are then notified about all
internal errors related to the source configuration object.
By inheriting from ConfigurationEvent
this event class
supports all properties that describe an operation on a configuration
instance. In addition a Throwable
object is available
representing the occurred error. The event's type determines the operation
that caused the error. Note that depending on the event type and the occurred
exception not all of the other properties (e.g. name of the affected property
or its value) may be available.
- Since:
- 1.4
- Version:
- $Id: ConfigurationErrorEvent.java 561230 2007-07-31 04:17:09Z rahul $
- Author:
- Commons
Configuration team
- See Also:
ConfigurationEvent
,
Serialized Form
ConfigurationErrorEvent
public ConfigurationErrorEvent(Object source,
int type,
String propertyName,
Object propertyValue,
Throwable cause)
- Creates a new instance of
ConfigurationErrorEvent
and
initializes it.
- Parameters:
source
- the event sourcetype
- the event's typepropertyName
- the name of the affected propertypropertyValue
- the value of the affected propertycause
- the exception object that caused this event
getCause
public Throwable getCause()
- Returns the cause of this error event. This is the
Throwable
object that caused this event to be fired.
- Returns:
- the cause of this error event
Copyright © 2001-2007 The Apache Software Foundation. All Rights Reserved.