Class BeanContextChildSupport

protected BeanContext beanContext

The parent BeanContext.

public BeanContextChild beanContextChildPeer

The peer on which to perform set actions. This is here so that this class can be used as a peer.

When extending this class, this variable will be set to this.

protected PropertyChangeSupport pcSupport

Listeners are registered here and events are fired through here.

protected boolean rejectedSetBCOnce

If setBeanContext() was vetoed once before, this is set to true so that the next time, vetoes will be ignored.

protected VetoableChangeSupport vcSupport

Listeners are registered here and events are fired through here.

public BeanContextChildSupport()

Create a new BeanContextChildSupport with itself as the peer. This is meant to be used when you subclass BeanContextChildSupport to create your child.

public BeanContextChildSupport(BeanContextChild peer)

Create a new BeanContextChildSupport with the specified peer.

Parameters:

peer - the peer to use, or null to specify this.

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

Add a listener that will be notified when a specific property changes.

Specified by:

addPropertyChangeListener in interface BeanContextChild

Parameters:

propertyName - the name of the property to listen on.

listener - the listener to listen on the property.

public void addVetoableChangeListener(String propertyName,
                                      VetoableChangeListener listener)

Add a listener that will be notified when a specific property change is requested (a PropertyVetoException may be thrown) as well as after the change is successfully made.

Specified by:

addVetoableChangeListener in interface BeanContextChild

Parameters:

propertyName - the name of the property to listen on.

listener - the listener to listen on the property.

public void firePropertyChange(String propertyName,
                               Object oldVal,
                               Object newVal)

Fire a property change.

Parameters:

propertyName - the name of the property that changed

oldVal - the old value of the property

newVal - the new value of the property

public void fireVetoableChange(String propertyName,
                               Object oldVal,
                               Object newVal)
            throws PropertyVetoException

Fire a vetoable property change.

Parameters:

propertyName - the name of the property that changed

oldVal - the old value of the property

newVal - the new value of the property

Throws:

PropertyVetoException - if the change is vetoed.

public BeanContext getBeanContext()

Get the parent BeanContext.

Specified by:

getBeanContext in interface BeanContextChild

Returns:

the parent BeanContext.

public BeanContextChild getBeanContextChildPeer()

Get the peer (or this if there is no peer).

Returns:

the peer, or this if there is no peer.

protected void initializeBeanContextResources()

Called by setBeanContext() to grab resources when the parent has been set.

This method is meant to be overriden. BeanContextChildSupport's implementation does nothing.

public boolean isDelegated()

Determine whether there is a peer. This is true iff getBeanContextChildPeer() == this.

Returns:

whether there is a peer.

protected void releaseBeanContextResources()

Called by setBeanContext() to release resources of a what will soon no longer be the parent.

This method is meant to be overriden. BeanContextChildSupport's implementation does nothing.

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

Remove a listener to a certain property.

Specified by:

removePropertyChangeListener in interface BeanContextChild

Parameters:

propertyName - the name of the property being listened on.

listener - the listener listening on the property.

public void removeVetoableChangeListener(String propertyName,
                                         VetoableChangeListener listener)

Remove a listener to a certain property.

Specified by:

removeVetoableChangeListener in interface BeanContextChild

Parameters:

propertyName - the name of the property being listened on

listener - the listener listening on the property.

public void serviceAvailable(BeanContextServiceAvailableEvent event)

Called by BeanContextServices whenever a service is made available.

This method is meant to be overriden. BeanContextChildSupport's implementation does nothing.

Specified by:

serviceAvailable in interface BeanContextServicesListener

Parameters:

event - the service revoked event, with useful information about the new service.

public void serviceRevoked(BeanContextServiceRevokedEvent event)

Called by BeanContextServices.revokeService() to indicate that a service has been revoked. If you have a reference to such a service, it should be discarded and may no longer function properly. getService() will no longer work on the specified service class after this event has been fired.

This method is meant to be overriden. BeanContextChildSupport's implementation does nothing.

Specified by:

serviceRevoked in interface BeanContextServiceRevokedListener

Parameters:

event - the service revoked event.

See Also:

BeanContextServices.revokeService(Class,BeanContextServiceProvider,boolean)

public void setBeanContext(BeanContext newBeanContext)
            throws PropertyVetoException

Set the parent BeanContext.

When this Object is being added to a new BeanContext or moved from an old one, a non-null value will be passed in.

When this Object is being removed from the current BeanContext, setBeanContext() will receive the parameter null.

Order of events:

1. If the new BeanContext is the same as the old one, nothing happens.
2. If the change has not been rejected or vetoed before, call validatePendingSetBeanContext(). If this call returns false, the change is rejected and a PropertyVetoException is thrown.
3. If the change has not been rejected or vetoed before, VetoableChangeEvents are fired with the name "beanContext", using the fireVetoableChange() method. If a veto occurs, reversion events are fired using the same method, the change is rejected, and the veto is rethrown.
4. releaseBeanContextResources() is called.
5. The change is made.
6. PropertyChangeEvents are fired using the firePropertyChange() method.
7. initializeBeanContextResources() is called.

Specified by:

setBeanContext in interface BeanContextChild

Parameters:

newBeanContext - the new parent for the BeanContextChild, or null to signify removal from a tree.

Throws:

PropertyVetoException - if the BeanContextChild implementor does not wish to have its parent changed.

public boolean validatePendingSetBeanContext(BeanContext newBeanContext)

Called by setBeanContext() to determine whether the set should be rejected.

This method is meant to be overriden. BeanContextChildSupport's implementation simply returns true.

Parameters:

newBeanContext - the new parent.

Returns:

whether to allow the parent to be changed to the new value.