Class ConfigurationErrorEvent
- java.lang.Object
-
- java.util.EventObject
-
- org.apache.commons.configuration.event.ConfigurationEvent
-
- org.apache.commons.configuration.event.ConfigurationErrorEvent
-
- All Implemented Interfaces:
java.io.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
orJNDIConfiguration
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 aThrowable
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 1207610 2011-11-28 21:06:22Z oheger $
- Author:
- Commons Configuration team
- See Also:
ConfigurationEvent
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ConfigurationErrorEvent(java.lang.Object source, int type, java.lang.String propertyName, java.lang.Object propertyValue, java.lang.Throwable cause)
Creates a new instance ofConfigurationErrorEvent
and initializes it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Throwable
getCause()
Returns the cause of this error event.-
Methods inherited from class org.apache.commons.configuration.event.ConfigurationEvent
getPropertyName, getPropertyValue, getType, isBeforeUpdate
-
-
-
-
Constructor Detail
-
ConfigurationErrorEvent
public ConfigurationErrorEvent(java.lang.Object source, int type, java.lang.String propertyName, java.lang.Object propertyValue, java.lang.Throwable cause)
Creates a new instance ofConfigurationErrorEvent
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
-
-
Method Detail
-
getCause
public java.lang.Throwable getCause()
Returns the cause of this error event. This is theThrowable
object that caused this event to be fired.- Returns:
- the cause of this error event
-
-