Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control.events
Class PropertiesChangeEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.beans.PropertyChangeEvent
          extended by com.avaya.conferencing.api.acp.control.events.PropertiesChangeEvent
All Implemented Interfaces:
java.io.Serializable

public class PropertiesChangeEvent
extends java.beans.PropertyChangeEvent

An extended form of PropertyChangeEvent that allows the receiver to obtain more information when multiple properties change in the same event.

The contract for PropertyChangeEvent allows that the property name may be set to null to indicate that an arbitrary set of its properties have changed. In this case both PropertyChangeEvent.getNewValue() and PropertyChangeEvent.getOldValue() must also return null. In these cases, the getPropertyNames(), getNewValues() and getOldValues() methods can be used to obtain details of which properties changed as well as their new and old values.

Since:
5.1.0.0.29
See Also:
PropertyChangeEvent, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PropertiesChangeEvent(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> oldValues, java.util.Map<java.lang.String,java.lang.Object> newValues)
          Constructs a new PropertiesChangeEvent instance.
PropertiesChangeEvent(java.lang.Object source, java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
          Constructs a new PropertiesChangeEvent instance.
 
Method Summary
 java.lang.Object getNewValue()
          Gets the new value for the property, expressed as an Object.
 java.util.Map<java.lang.String,java.lang.Object> getNewValues()
          Gets the new values for the properties, expressed as a map keyed off the property names with values expressed as Objects.
 java.lang.Object getOldValue()
          Gets the old value for the property, expressed as an Object.
 java.util.Map<java.lang.String,java.lang.Object> getOldValues()
          Gets the old values for the properties, expressed as a map keyed off the property names with values expressed as Objects.
 java.util.Set<java.lang.String> getPropertyNames()
          Gets the programmatic names of the properties that were changed.
 
Methods inherited from class java.beans.PropertyChangeEvent
getPropagationId, getPropertyName, setPropagationId
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PropertiesChangeEvent

public PropertiesChangeEvent(java.lang.Object source,
                             java.util.Map<java.lang.String,java.lang.Object> oldValues,
                             java.util.Map<java.lang.String,java.lang.Object> newValues)
Constructs a new PropertiesChangeEvent instance.

Parameters:
source - The bean that fired the event.
oldValues - The map containing all the old property values keyed off the property names. This constructor makes a copy of the map and leaves the original unchanged.
newValues - The map containing all the new property values keyed off the property names. This constructor makes a copy of the map and leaves the original unchanged.
Since:
5.1.0.0.29

PropertiesChangeEvent

public PropertiesChangeEvent(java.lang.Object source,
                             java.lang.String propertyName,
                             java.lang.Object oldValue,
                             java.lang.Object newValue)
Constructs a new PropertiesChangeEvent instance.

Parameters:
source - The bean that fired the event.
propertyName - The programmatic name of the property that was changed.
oldValue - The old value of the property.
newValue - The new value of the property.
Since:
5.1.0.0.29
Method Detail

getNewValue

public java.lang.Object getNewValue()
Gets the new value for the property, expressed as an Object.

Overrides:
getNewValue in class java.beans.PropertyChangeEvent
Returns:
The new value for the property, expressed as an Object. May be null if multiple properties have changed.
Since:
5.1.0.0.29

getNewValues

public java.util.Map<java.lang.String,java.lang.Object> getNewValues()
Gets the new values for the properties, expressed as a map keyed off the property names with values expressed as Objects.

Returns:
The new values for the properties, expressed as a map keyed off the property names with values expressed as Objects.
Since:
5.1.0.0.29

getOldValue

public java.lang.Object getOldValue()
Gets the old value for the property, expressed as an Object.

Overrides:
getOldValue in class java.beans.PropertyChangeEvent
Returns:
The old value for the property, expressed as an Object. May be null if multiple properties have changed.
Since:
5.1.0.0.29

getOldValues

public java.util.Map<java.lang.String,java.lang.Object> getOldValues()
Gets the old values for the properties, expressed as a map keyed off the property names with values expressed as Objects.

Returns:
The old values for the properties, expressed as a map keyed off the property names with values expressed as Objects.
Since:
5.1.0.0.29

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()
Gets the programmatic names of the properties that were changed.

Returns:
The programmatic names of the properties that were changed.
Since:
5.1.0.0.29

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.