File Doc Category Size Date Package
BeanContextChild.java API Doc Java SE 5 API 4526 Fri Aug 26 14:56:58 BST 2005 java.beans.beancontext

BeanContextChild

public interface BeanContextChild

JavaBeans wishing to be nested within, and obtain a reference to their execution environment, or context, as defined by the BeanContext sub-interface shall implement this interface.

Conformant BeanContexts shall as a side effect of adding a BeanContextChild object shall pass a reference to itself via the setBeanContext() method of this interface.

Note that a BeanContextChild may refuse a change in state by throwing PropertyVetoedException in response.

In order for persistence mechanisms to function properly on BeanContextChild instances across a broad variety of scenarios, implementing classes of this interface are required to define as transient, any or all fields, or instance variables, that may contain, or represent, references to the nesting BeanContext instance or other resources obtained from the BeanContext via any unspecified mechanisms.

author: Laurence P. G. Cable
version: 1.20, 12/19/03
since: 1.2
see: java.beans.beancontext.BeanContext
see: java.beans.PropertyChangeEvent
see: java.beans.PropertyChangeListener
see: java.beans.PropertyVetoEvent
see: java.beans.PropertyVetoListener
see: java.beans.PropertyVetoException

Fields Summary
Constructors Summary
Methods Summary
public void addPropertyChangeListener(java.lang.String name, java.beans.PropertyChangeListener pcl)
Adds a PropertyChangeListener to this BeanContextChild in order to receive a PropertyChangeEvent whenever the specified property has changed.
param
name the name of the property to listen on
param
pcl the PropertyChangeListener to add
public void addVetoableChangeListener(java.lang.String name, java.beans.VetoableChangeListener vcl)
Adds a VetoableChangeListener to this BeanContextChild to receive events whenever the specified property changes.
param
name the name of the property to listen on
param
vcl the VetoableChangeListener to add
public java.beans.beancontext.BeanContext getBeanContext()
Gets the BeanContext associated with this BeanContextChild.
return
the BeanContext associated with this BeanContextChild.
public void removePropertyChangeListener(java.lang.String name, java.beans.PropertyChangeListener pcl)
Removes a PropertyChangeListener from this BeanContextChild so that it no longer receives PropertyChangeEvents when the specified property is changed.
param
name the name of the property that was listened on
param
pcl the PropertyChangeListener to remove
public void removeVetoableChangeListener(java.lang.String name, java.beans.VetoableChangeListener vcl)
Removes a VetoableChangeListener from this BeanContextChild so that it no longer receives events when the specified property changes.
param
name the name of the property that was listened on.
param
vcl the VetoableChangeListener to remove.
public void setBeanContext(java.beans.beancontext.BeanContext bc)
Objects that implement this interface, shall fire a java.beans.PropertyChangeEvent, with parameters: propertyName "beanContext", oldValue (the previous nesting BeanContext instance, or null), newValue (the current nesting BeanContext instance, or null).
A change in the value of the nesting BeanContext property of this BeanContextChild may be vetoed by throwing the appropriate exception.
param
bc The BeanContext with which to associate this BeanContextChild.
throws
PropertyVetoException if the addition of the specified BeanContext is refused.