java.lang.Object
java.beans.beancontext.BeanContextChildSupport
- All Implemented Interfaces:
BeanContextChild
,BeanContextServiceRevokedListener
,BeanContextServicesListener
,Serializable
,EventListener
- Direct Known Subclasses:
BeanContextSupport
public class BeanContextChildSupport
extends Object
implements BeanContextChild, BeanContextServicesListener, Serializable
This is a general support class to provide support for implementing the BeanContextChild protocol. This class may either be directly subclassed, or encapsulated and delegated to in order to implement this interface for a given component.
- Since:
- 1.2
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected BeanContext
The bean context.TheBeanContext
in which thisBeanContextChild
is nested.protected PropertyChangeSupport
ThePropertyChangeSupport
associated with thisBeanContextChildSupport
.protected boolean
A flag indicating that there has been at least onePropertyChangeVetoException
thrown for the attempted setBeanContext operation.protected VetoableChangeSupport
TheVetoableChangeSupport
associated with thisBeanContextChildSupport
. -
Constructor Summary
ConstructorDescriptionconstruct a BeanContextChildSupport where this class has been subclassed in order to implement the JavaBean component itself.construct a BeanContextChildSupport where the JavaBean component itself implements BeanContextChild, and encapsulates this, delegating that interface to this implementation -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a PropertyChangeListener for a specific property.void
Add a VetoableChangeListener for a specific property.void
firePropertyChange
(String name, Object oldValue, Object newValue) Report a bound property update to any registered listeners.void
fireVetoableChange
(String name, Object oldValue, Object newValue) Report a vetoable property update to any registered listeners.Gets the nestingBeanContext
for thisBeanContextChildSupport
.Gets theBeanContextChild
associated with thisBeanContextChildSupport
.protected void
This method may be overridden by subclasses to provide their own initialization behaviors.boolean
Reports whether or not this class is a delegate of another.protected void
This method may be overridden by subclasses to provide their own release behaviors.void
Remove a PropertyChangeListener for a specific property.void
Removes aVetoableChangeListener
.void
A new service is available from the nesting BeanContext.void
A service provided by the nesting BeanContext has been revoked.void
Sets theBeanContext
for thisBeanContextChildSupport
.boolean
validatePendingSetBeanContext
(BeanContext newValue) Called from setBeanContext to validate (or otherwise) the pending change in the nesting BeanContext property value.
-
Field Details
-
beanContextChildPeer
TheBeanContext
in which thisBeanContextChild
is nested. -
pcSupport
ThePropertyChangeSupport
associated with thisBeanContextChildSupport
. -
vcSupport
TheVetoableChangeSupport
associated with thisBeanContextChildSupport
. -
beanContext
The bean context. -
rejectedSetBCOnce
protected transient boolean rejectedSetBCOnceA flag indicating that there has been at least onePropertyChangeVetoException
thrown for the attempted setBeanContext operation.
-
-
Constructor Details
-
BeanContextChildSupport
public BeanContextChildSupport()construct a BeanContextChildSupport where this class has been subclassed in order to implement the JavaBean component itself. -
BeanContextChildSupport
construct a BeanContextChildSupport where the JavaBean component itself implements BeanContextChild, and encapsulates this, delegating that interface to this implementation- Parameters:
bcc
- the underlying bean context child
-
-
Method Details
-
setBeanContext
Sets theBeanContext
for thisBeanContextChildSupport
.- Specified by:
setBeanContext
in interfaceBeanContextChild
- Parameters:
bc
- the new value to be assigned to theBeanContext
property- Throws:
PropertyVetoException
- if the change is rejected
-
getBeanContext
Gets the nestingBeanContext
for thisBeanContextChildSupport
.- Specified by:
getBeanContext
in interfaceBeanContextChild
- Returns:
- the nesting
BeanContext
for thisBeanContextChildSupport
.
-
addPropertyChangeListener
Add a PropertyChangeListener for a specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. Ifname
orpcl
is null, no exception is thrown and no action is taken.- Specified by:
addPropertyChangeListener
in interfaceBeanContextChild
- Parameters:
name
- The name of the property to listen onpcl
- ThePropertyChangeListener
to be added
-
removePropertyChangeListener
Remove a PropertyChangeListener for a specific property. Ifpcl
was added more than once to the same event source for the specified property, it will be notified one less time after being removed. Ifname
is null, no exception is thrown and no action is taken. Ifpcl
is null, or was never added for the specified property, no exception is thrown and no action is taken.- Specified by:
removePropertyChangeListener
in interfaceBeanContextChild
- Parameters:
name
- The name of the property that was listened onpcl
- The PropertyChangeListener to be removed
-
addVetoableChangeListener
Add a VetoableChangeListener for a specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. Ifname
orvcl
is null, no exception is thrown and no action is taken.- Specified by:
addVetoableChangeListener
in interfaceBeanContextChild
- Parameters:
name
- The name of the property to listen onvcl
- TheVetoableChangeListener
to be added
-
removeVetoableChangeListener
Removes aVetoableChangeListener
. Ifpcl
was added more than once to the same event source for the specified property, it will be notified one less time after being removed. Ifname
is null, no exception is thrown and no action is taken. Ifvcl
is null, or was never added for the specified property, no exception is thrown and no action is taken.- Specified by:
removeVetoableChangeListener
in interfaceBeanContextChild
- Parameters:
name
- The name of the property that was listened onvcl
- TheVetoableChangeListener
to be removed
-
serviceRevoked
A service provided by the nesting BeanContext has been revoked. Subclasses may override this method in order to implement their own behaviors.- Specified by:
serviceRevoked
in interfaceBeanContextServiceRevokedListener
- Parameters:
bcsre
- TheBeanContextServiceRevokedEvent
fired as a result of a service being revoked
-
serviceAvailable
A new service is available from the nesting BeanContext. Subclasses may override this method in order to implement their own behaviors- Specified by:
serviceAvailable
in interfaceBeanContextServicesListener
- Parameters:
bcsae
- The BeanContextServiceAvailableEvent fired as a result of a service becoming available
-
getBeanContextChildPeer
Gets theBeanContextChild
associated with thisBeanContextChildSupport
.- Returns:
- the
BeanContextChild
peer of this class
-
isDelegated
public boolean isDelegated()Reports whether or not this class is a delegate of another.- Returns:
- true if this class is a delegate of another
-
firePropertyChange
Report a bound property update to any registered listeners. No event is fired if old and new are equal and non-null.- Parameters:
name
- The programmatic name of the property that was changedoldValue
- The old value of the propertynewValue
- The new value of the property
-
fireVetoableChange
public void fireVetoableChange(String name, Object oldValue, Object newValue) throws PropertyVetoException Report a vetoable property update to any registered listeners. If anyone vetos the change, then fire a new event reverting everyone to the old value and then rethrow the PropertyVetoException.No event is fired if old and new are equal and non-null.
- Parameters:
name
- The programmatic name of the property that is about to changeoldValue
- The old value of the propertynewValue
- - The new value of the property- Throws:
PropertyVetoException
- if the recipient wishes the property change to be rolled back.
-
validatePendingSetBeanContext
Called from setBeanContext to validate (or otherwise) the pending change in the nesting BeanContext property value. Returning false will cause setBeanContext to throw PropertyVetoException.- Parameters:
newValue
- the new value that has been requested for the BeanContext property- Returns:
true
if the change operation is to be vetoed
-
releaseBeanContextResources
protected void releaseBeanContextResources()This method may be overridden by subclasses to provide their own release behaviors. When invoked any resources held by this instance obtained from its current BeanContext property should be released since the object is no longer nested within that BeanContext. -
initializeBeanContextResources
protected void initializeBeanContextResources()This method may be overridden by subclasses to provide their own initialization behaviors. When invoked any resources required by the BeanContextChild should be obtained from the current BeanContext.
-