Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Class ConfigurationChangeEvent

java.lang.Object

java.util.EventObject

org.tquadrat.foundation.config.ConfigurationChangeEvent

All Implemented Interfaces:

Serializable

@ClassVersion(sourceVersion="$Id: ConfigurationChangeEvent.java 1078 2023-10-19 14:39:47Z tquadrat $")
@API(status=STABLE,
     since="0.0.1")
public final class ConfigurationChangeEvent
extends EventObject

The event object that is thrown each time a property of a configuration bean is changed.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ConfigurationChangeEvent.java 1078 2023-10-19 14:39:47Z tquadrat $

Since:

0.0.1

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.ConfigurationChangeEvent"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Object	m_NewValue	The new value of the property.
private final Object	m_OldValue	The old value of the property.
private final String	m_PropertyName	The name of the property.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ConfigurationChangeEvent(ConfigBeanSpec sourceBean, String propertyName, Object oldValue, Object newValue)	Creates a new ConfigurationChangeEvent instance.

Method Summary

Modifier and Type	Method	Description
final Object	getNewValue()	Gets the new value for the property, expressed as an instance of Object.
final Object	getOldValue()	Gets the old value for the property, expressed as an instance of Object.
final String	getPropertyName()	Gets the name of the configuration property that was changed.
final ConfigBeanSpec	getSource()
final String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

m_NewValue

private final Object m_NewValue

The new value of the property.

m_OldValue

private final Object m_OldValue

The old value of the property.

m_PropertyName

private final String m_PropertyName

The name of the property.

Constructor Details

ConfigurationChangeEvent

public ConfigurationChangeEvent(ConfigBeanSpec sourceBean,
 String propertyName,
 Object oldValue,
 Object newValue)

Creates a new ConfigurationChangeEvent instance.

Parameters:

sourceBean - The reference to the configuration bean that fired the change event.

propertyName - The name of the property that was modified.

oldValue - The property's value before the change; obviously, this can be null, depending on the property.

newValue - The new value of the property; if allowed by the property, this can be null also.

Method Details

getNewValue

public final Object getNewValue()

Gets the new value for the property, expressed as an instance of Object.

Returns:

The new value for the property, expressed as an instance of Object. May be null.

getOldValue

public final Object getOldValue()

Gets the old value for the property, expressed as an instance of Object.

Returns:

The old value for the property, expressed as an instance of Object. May be null.

getPropertyName

public final String getPropertyName()

Gets the name of the configuration property that was changed.

Returns:

The name of the property that was changed.

getSource

public final ConfigBeanSpec getSource()

Overrides:

getSource in class EventObject

toString

public final String toString()

Overrides:

toString in class EventObject