public class

BeanContextChildSupport

extends Object
implements BeanContextChild BeanContextServicesListener Serializable
java.lang.Object
   ↳ java.beans.beancontext.BeanContextChildSupport
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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.

Summary

Fields
protected BeanContext beanContext
public BeanContextChild beanContextChildPeer The BeanContext in which this BeanContextChild is nested.
protected PropertyChangeSupport pcSupport The PropertyChangeSupport associated with this BeanContextChildSupport.
protected boolean rejectedSetBCOnce A flag indicating that there has been at least one PropertyChangeVetoException thrown for the attempted setBeanContext operation.
protected VetoableChangeSupport vcSupport The VetoableChangeSupport associated with this BeanContextChildSupport.
Public Constructors
BeanContextChildSupport()
construct a BeanContextChildSupport where this class has been subclassed in order to implement the JavaBean component itself.
BeanContextChildSupport(BeanContextChild bcc)
construct a BeanContextChildSupport where the JavaBean component itself implements BeanContextChild, and encapsulates this, delegating that interface to this implementation
Public Methods
void addPropertyChangeListener(String name, PropertyChangeListener pcl)
Add a PropertyChangeListener for a specific property.
void addVetoableChangeListener(String name, VetoableChangeListener vcl)
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.
synchronized BeanContext getBeanContext()
Gets the nesting BeanContext for this BeanContextChildSupport.
BeanContextChild getBeanContextChildPeer()
Gets the BeanContextChild associated with this BeanContextChildSupport.
boolean isDelegated()
Reports whether or not this class is a delegate of another.
void removePropertyChangeListener(String name, PropertyChangeListener pcl)
Remove a PropertyChangeListener for a specific property.
void removeVetoableChangeListener(String name, VetoableChangeListener vcl)
Removes a VetoableChangeListener.
void serviceAvailable(BeanContextServiceAvailableEvent bcsae)
A new service is available from the nesting BeanContext.
void serviceRevoked(BeanContextServiceRevokedEvent bcsre)
A service provided by the nesting BeanContext has been revoked.
synchronized void setBeanContext(BeanContext bc)
Sets the BeanContext for this BeanContextChildSupport.
boolean validatePendingSetBeanContext(BeanContext newValue)
Called from setBeanContext to validate (or otherwise) the pending change in the nesting BeanContext property value.
Protected Methods
void initializeBeanContextResources()
This method may be overridden by subclasses to provide their own initialization behaviors.
void releaseBeanContextResources()
This method may be overridden by subclasses to provide their own release behaviors.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.beans.beancontext.BeanContextChild
From interface java.beans.beancontext.BeanContextServiceRevokedListener
From interface java.beans.beancontext.BeanContextServicesListener

Fields

protected BeanContext beanContext

public BeanContextChild beanContextChildPeer

The BeanContext in which this BeanContextChild is nested.

protected PropertyChangeSupport pcSupport

The PropertyChangeSupport associated with this BeanContextChildSupport.

protected boolean rejectedSetBCOnce

A flag indicating that there has been at least one PropertyChangeVetoException thrown for the attempted setBeanContext operation.

protected VetoableChangeSupport vcSupport

The VetoableChangeSupport associated with this BeanContextChildSupport.

Public Constructors

public BeanContextChildSupport ()

construct a BeanContextChildSupport where this class has been subclassed in order to implement the JavaBean component itself.

public BeanContextChildSupport (BeanContextChild bcc)

construct a BeanContextChildSupport where the JavaBean component itself implements BeanContextChild, and encapsulates this, delegating that interface to this implementation

Public Methods

public void addPropertyChangeListener (String name, PropertyChangeListener pcl)

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. If name or pcl is null, no exception is thrown and no action is taken.

Parameters
name The name of the property to listen on
pcl The PropertyChangeListener to be added

public void addVetoableChangeListener (String name, VetoableChangeListener vcl)

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. If name or vcl is null, no exception is thrown and no action is taken.

Parameters
name The name of the property to listen on
vcl The VetoableChangeListener to be added

public void firePropertyChange (String name, Object oldValue, Object newValue)

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 changed
oldValue The old value of the property
newValue The new value of the property

public void fireVetoableChange (String name, Object oldValue, Object newValue)

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 change
oldValue The old value of the property
newValue - The new value of the property
Throws
PropertyVetoException if the recipient wishes the property change to be rolled back.

public synchronized BeanContext getBeanContext ()

Gets the nesting BeanContext for this BeanContextChildSupport.

Returns
  • the nesting BeanContext for this BeanContextChildSupport.

public BeanContextChild getBeanContextChildPeer ()

Gets the BeanContextChild associated with this BeanContextChildSupport.

Returns
  • the BeanContextChild peer of this class

public boolean isDelegated ()

Reports whether or not this class is a delegate of another.

Returns
  • true if this class is a delegate of another

public void removePropertyChangeListener (String name, PropertyChangeListener pcl)

Remove a PropertyChangeListener for a specific property. If pcl was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If name is null, no exception is thrown and no action is taken. If pcl is null, or was never added for the specified property, no exception is thrown and no action is taken.

Parameters
name The name of the property that was listened on
pcl The PropertyChangeListener to be removed

public void removeVetoableChangeListener (String name, VetoableChangeListener vcl)

Removes a VetoableChangeListener. If pcl was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If name is null, no exception is thrown and no action is taken. If vcl is null, or was never added for the specified property, no exception is thrown and no action is taken.

Parameters
name The name of the property that was listened on
vcl The VetoableChangeListener to be removed

public void serviceAvailable (BeanContextServiceAvailableEvent bcsae)

A new service is available from the nesting BeanContext. Subclasses may override this method in order to implement their own behaviors

Parameters
bcsae The BeanContextServiceAvailableEvent fired as a result of a service becoming available

public void serviceRevoked (BeanContextServiceRevokedEvent bcsre)

A service provided by the nesting BeanContext has been revoked. Subclasses may override this method in order to implement their own behaviors.

Parameters
bcsre The BeanContextServiceRevokedEvent fired as a result of a service being revoked

public synchronized void setBeanContext (BeanContext bc)

Sets the BeanContext for this BeanContextChildSupport.

Parameters
bc the new value to be assigned to the BeanContext property
Throws
if the change is rejected
PropertyVetoException

public boolean validatePendingSetBeanContext (BeanContext newValue)

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

Protected Methods

protected void initializeBeanContextResources ()

This method may be overridden by subclasses to provide their own initialization behaviors. When invoked any resources requried by the BeanContextChild should be obtained from the current BeanContext.

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.