Class BeanContextSupport
- All Implemented Interfaces:
BeanContext
,BeanContextChild
,BeanContextServiceRevokedListener
,BeanContextServicesListener
,DesignMode
,PropertyChangeListener
,VetoableChangeListener
,Visibility
,Serializable
,Iterable
,Collection
,EventListener
- Direct Known Subclasses:
BeanContextServicesSupport
Since this class directly implements the BeanContext interface, the class can, and is intended to be used either by subclassing this implementation, or via ad-hoc delegation of an instance of this class from another.
- Since:
- 1.2
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
A protected nested class containing per-child information in thechildren
hashtable.protected static final class
protected final subclass that encapsulates an iterator but implements a noop remove() method. -
Field Summary
Modifier and TypeFieldDescriptionprotected ArrayList
<BeanContextMembershipListener> all accesses to theprotected ArrayList bcmListeners
field shall be synchronized on that object.protected HashMap
<Object, BeanContextSupport.BCSChild> all accesses to theprotected HashMap children
field shall be synchronized on that object.protected boolean
Aboolean
indicating whether or not this object is currently in design time mode.protected Locale
The current locale of this BeanContext.protected boolean
Aboolean
indicating if this instance may now render a GUI.Fields declared in class java.beans.beancontext.BeanContextChildSupport
beanContext, beanContextChildPeer, pcSupport, rejectedSetBCOnce, vcSupport
Fields declared in interface java.beans.beancontext.BeanContext
globalHierarchyLock
Fields declared in interface java.beans.DesignMode
PROPERTYNAME
-
Constructor Summary
ConstructorDescriptionCreate an instance that is not a delegate of another objectCreate an instance using with a default localeBeanContextSupport
(BeanContext peer, Locale lcle) Create an instance using the specified localeBeanContextSupport
(BeanContext peer, Locale lcle, boolean dtime) Create an instance using the specified Locale and design mode.BeanContextSupport
(BeanContext peer, Locale lcle, boolean dTime, boolean visible) Construct a BeanContextSupport instance -
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds/nests a child within thisBeanContext
.boolean
addAll
(Collection c) add Collection to set of Children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected fieldvoid
Adds a BeanContextMembershipListenerboolean
Used to determine if theBeanContext
child is avoiding using its GUI.protected Iterator
<BeanContextSupport.BCSChild> Returns an iterator of all children of thisBeanContext
.protected void
called by readObject after defaultReadObject() but prior to deserialization of any children.protected void
called by writeObject after defaultWriteObject() but prior to serialization of currently serializable children.protected void
childDeserializedHook
(Object child, BeanContextSupport.BCSChild bcsc) Called by readObject with the newly deserialized child and BCSChild.protected void
childJustAddedHook
(Object child, BeanContextSupport.BCSChild bcsc) subclasses may override this method to simply extend add() semantics after the child has been added and before the event notification has occurred.protected void
childJustRemovedHook
(Object child, BeanContextSupport.BCSChild bcsc) subclasses may override this method to simply extend remove() semantics after the child has been removed and before the event notification has occurred.protected static final boolean
classEquals
(Class<?> first, Class<?> second) Tests to see if two class objects, or their names are equal.void
clear()
clear the children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected fieldboolean
Determines whether or not the specified object is currently a child of thisBeanContext
.boolean
Tests to see if all objects in the specifiedCollection
are children of thisBeanContext
.boolean
Determines whether or not the specified object is currently a child of thisBeanContext
.protected final Object[]
Gets a copy of the this BeanContext's children.protected BeanContextSupport.BCSChild
createBCSChild
(Object targetChild, Object peer) Subclasses can override this method to insert their own subclass of Child without having to override add() or the other Collection methods that add children to the set.protected final void
deserialize
(ObjectInputStream ois, Collection coll) used by readObject to deserialize a collection.void
notify this instance that it may no longer render a GUI.protected final void
Fire a BeanContextMembershipEvent on the BeanContextMembershipListener interfaceprotected final void
Fire a BeanContextMembershipEvent on the BeanContextMembershipListener interfaceGets the instance ofBeanContext
that this object is providing the implementation for.protected static final BeanContextChild
getChildBeanContextChild
(Object child) Gets the BeanContextChild (if any) of the specified childprotected static final BeanContextMembershipListener
Gets the BeanContextMembershipListener (if any) of the specified childprotected static final PropertyChangeListener
Gets the PropertyChangeListener (if any) of the specified childprotected static final Serializable
getChildSerializable
(Object child) Gets the Serializable (if any) associated with the specified Childprotected static final VetoableChangeListener
Gets the VetoableChangeListener (if any) of the specified childprotected static final Visibility
getChildVisibility
(Object child) Gets the Component (if any) associated with the specified child.Gets the locale for thisBeanContext
.getResource
(String name, BeanContextChild bcc) Analogous tojava.lang.ClassLoader.getResource()
, this method allows aBeanContext
implementation to interpose behavior between the childComponent
and underlyingClassLoader
.getResourceAsStream
(String name, BeanContextChild bcc) Analogous tojava.lang.ClassLoader.getResourceAsStream()
, this method allows aBeanContext
implementation to interpose behavior between the childComponent
and underlyingClassLoader
.protected void
protected method called from constructor and readObject to initialize transient state of BeanContextSupport instance.instantiateChild
(String beanName) The instantiateChild method is a convenience hook in BeanContext to simplify the task of instantiating a Bean, nested, into aBeanContext
.boolean
Reports whether or not this object is in currently in design time mode.boolean
isEmpty()
Reports whether or not thisBeanContext
is empty.boolean
Is thisBeanContext
in the process of being serialized?iterator()
Gets all JavaBean orBeanContext
instances currently nested in thisBeanContext
.boolean
needsGui()
This method is typically called from the environment in order to determine if the implementor "needs" a GUI.void
Notify this instance that it may now render a GUIvoid
subclasses may envelope to monitor child property changes.final void
When an instance of this class is used as a delegate for the implementation of the BeanContext protocols (and its subprotocols) there exists a 'chicken and egg' problem during deserializationboolean
Removes a child from this BeanContext.protected boolean
internal remove used when removal caused by unexpectedsetBeanContext
or byremove()
invocation.boolean
remove all specified children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected fieldvoid
Removes a BeanContextMembershipListenerboolean
retain only specified children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected fieldprotected final void
serialize
(ObjectOutputStream oos, Collection<?> coll) Used by writeObject to serialize a Collection.void
setDesignTime
(boolean dTime) Sets the new design time value for thisBeanContext
.void
Sets the locale of this BeanContext.int
size()
Gets the number of children currently nested in this BeanContext.Object[]
toArray()
Gets all JavaBean orBeanContext
instances currently nested in this BeanContext.Object[]
Gets an array containing all children of thisBeanContext
that match the types contained in arry.protected boolean
validatePendingAdd
(Object targetChild) Subclasses of this class may override, or envelope, this method to add validation behavior for the BeanContext to examine child objects immediately prior to their being added to the BeanContext.protected boolean
validatePendingRemove
(Object targetChild) Subclasses of this class may override, or envelope, this method to add validation behavior for the BeanContext to examine child objects immediately prior to their being removed from the BeanContext.void
subclasses may envelope to monitor veto child property changes.final void
Used to serialize all children of thisBeanContext
.Methods declared in class java.beans.beancontext.BeanContextChildSupport
addPropertyChangeListener, addVetoableChangeListener, firePropertyChange, fireVetoableChange, getBeanContext, getBeanContextChildPeer, initializeBeanContextResources, isDelegated, releaseBeanContextResources, removePropertyChangeListener, removeVetoableChangeListener, serviceAvailable, serviceRevoked, setBeanContext, validatePendingSetBeanContext
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface java.beans.beancontext.BeanContextChild
addPropertyChangeListener, addVetoableChangeListener, getBeanContext, removePropertyChangeListener, removeVetoableChangeListener, setBeanContext
Methods declared in interface java.util.Collection
equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray
-
Field Details
-
children
all accesses to theprotected HashMap children
field shall be synchronized on that object. -
bcmListeners
all accesses to theprotected ArrayList bcmListeners
field shall be synchronized on that object. -
locale
The current locale of this BeanContext. -
okToUseGui
protected boolean okToUseGuiAboolean
indicating if this instance may now render a GUI. -
designTime
protected boolean designTimeAboolean
indicating whether or not this object is currently in design time mode.
-
-
Constructor Details
-
BeanContextSupport
Construct a BeanContextSupport instance- Parameters:
peer
- The peerBeanContext
we are supplying an implementation for, ornull
if this object is its own peerlcle
- The current Locale for this BeanContext. Iflcle
isnull
, the default locale is assigned to theBeanContext
instance.dTime
- The initial state,true
if in design mode,false
if runtime.visible
- The initial visibility.- See Also:
-
BeanContextSupport
Create an instance using the specified Locale and design mode.- Parameters:
peer
- The peerBeanContext
we are supplying an implementation for, ornull
if this object is its own peerlcle
- The current Locale for thisBeanContext
. Iflcle
isnull
, the default locale is assigned to theBeanContext
instance.dtime
- The initial state,true
if in design mode,false
if runtime.- See Also:
-
BeanContextSupport
Create an instance using the specified locale- Parameters:
peer
- The peer BeanContext we are supplying an implementation for, ornull
if this object is its own peerlcle
- The current Locale for thisBeanContext
. Iflcle
isnull
, the default locale is assigned to theBeanContext
instance.- See Also:
-
BeanContextSupport
Create an instance using with a default locale- Parameters:
peer
- The peerBeanContext
we are supplying an implementation for, ornull
if this object is its own peer
-
BeanContextSupport
public BeanContextSupport()Create an instance that is not a delegate of another object
-
-
Method Details
-
getBeanContextPeer
Gets the instance ofBeanContext
that this object is providing the implementation for.- Returns:
- the BeanContext instance
-
instantiateChild
The instantiateChild method is a convenience hook in BeanContext to simplify the task of instantiating a Bean, nested, into a
BeanContext
.The semantics of the beanName parameter are defined by java.beans.Beans.instantiate.
- Specified by:
instantiateChild
in interfaceBeanContext
- Parameters:
beanName
- the name of the Bean to instantiate within this BeanContext- Returns:
- the new object
- Throws:
IOException
- if there is an I/O error when the bean is being deserializedClassNotFoundException
- if the class identified by the beanName parameter is not found
-
size
public int size()Gets the number of children currently nested in this BeanContext.- Specified by:
size
in interfaceCollection
- Returns:
- number of children
-
isEmpty
public boolean isEmpty()Reports whether or not thisBeanContext
is empty. ABeanContext
is considered empty when it contains zero nested children.- Specified by:
isEmpty
in interfaceCollection
- Returns:
true
if there are no children, otherwisefalse
-
contains
Determines whether or not the specified object is currently a child of thisBeanContext
.- Specified by:
contains
in interfaceCollection
- Parameters:
o
- the Object in question- Returns:
true
if this object is a child, otherwisefalse
-
containsKey
Determines whether or not the specified object is currently a child of thisBeanContext
.- Parameters:
o
- the Object in question- Returns:
true
if this object is a child, otherwisefalse
-
iterator
-
toArray
Gets all JavaBean orBeanContext
instances currently nested in this BeanContext.- Specified by:
toArray
in interfaceCollection
- Returns:
- an array, whose runtime component
type is
Object
, containing all of the elements in this collection
-
toArray
Gets an array containing all children of thisBeanContext
that match the types contained in arry.- Specified by:
toArray
in interfaceCollection
- Parameters:
arry
- The array of object types that are of interest.- Returns:
- an array of children
-
createBCSChild
Subclasses can override this method to insert their own subclass of Child without having to override add() or the other Collection methods that add children to the set.
- Parameters:
targetChild
- the child to create the Child on behalf ofpeer
- the peer if the tragetChild and the peer are related by an implementation of BeanContextProxy- Returns:
- Subtype-specific subclass of Child without overriding collection methods
-
add
Adds/nests a child within thisBeanContext
.Invoked as a side effect of java.beans.Beans.instantiate(). If the child object is not valid for adding then this method throws an IllegalStateException.
- Specified by:
add
in interfaceCollection
- Parameters:
targetChild
- The child objects to nest within thisBeanContext
- Returns:
- true if the child was added successfully.
- See Also:
-
remove
Removes a child from this BeanContext. If the child object is not for adding then this method throws an IllegalStateException.- Specified by:
remove
in interfaceCollection
- Parameters:
targetChild
- The child objects to remove- Returns:
true
if an element was removed as a result of this call- See Also:
-
remove
internal remove used when removal caused by unexpectedsetBeanContext
or byremove()
invocation.- Parameters:
targetChild
- the JavaBean, BeanContext, or Object to be removedcallChildSetBC
- used to indicate that the child should be notified that it is no longer nested in thisBeanContext
.- Returns:
- whether or not was present before being removed
-
containsAll
Tests to see if all objects in the specifiedCollection
are children of thisBeanContext
.- Specified by:
containsAll
in interfaceCollection
- Parameters:
c
- the specifiedCollection
- Returns:
true
if all objects in the collection are children of thisBeanContext
, false if not.- See Also:
-
addAll
add Collection to set of Children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected field- Specified by:
addAll
in interfaceCollection
- Parameters:
c
- collection containing elements to be added to this collection- Returns:
- this implementation unconditionally throws
UnsupportedOperationException
- Throws:
UnsupportedOperationException
- thrown unconditionally by this implementation- See Also:
-
removeAll
remove all specified children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected field- Specified by:
removeAll
in interfaceCollection
- Parameters:
c
- collection containing elements to be removed from this collection- Returns:
- this implementation unconditionally throws
UnsupportedOperationException
- Throws:
UnsupportedOperationException
- thrown unconditionally by this implementation- See Also:
-
retainAll
retain only specified children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected field- Specified by:
retainAll
in interfaceCollection
- Parameters:
c
- collection containing elements to be retained in this collection- Returns:
- this implementation unconditionally throws
UnsupportedOperationException
- Throws:
UnsupportedOperationException
- thrown unconditionally by this implementation- See Also:
-
clear
public void clear()clear the children (Unsupported) implementations must synchronized on the hierarchy lock and "children" protected field- Specified by:
clear
in interfaceCollection
- Throws:
UnsupportedOperationException
- thrown unconditionally by this implementation
-
addBeanContextMembershipListener
Adds a BeanContextMembershipListener- Specified by:
addBeanContextMembershipListener
in interfaceBeanContext
- Parameters:
bcml
- the BeanContextMembershipListener to add- Throws:
NullPointerException
- if the argument is null
-
removeBeanContextMembershipListener
Removes a BeanContextMembershipListener- Specified by:
removeBeanContextMembershipListener
in interfaceBeanContext
- Parameters:
bcml
- the BeanContextMembershipListener to remove- Throws:
NullPointerException
- if the argument is null
-
getResourceAsStream
Description copied from interface:BeanContext
Analogous tojava.lang.ClassLoader.getResourceAsStream()
, this method allows aBeanContext
implementation to interpose behavior between the childComponent
and underlyingClassLoader
.- Specified by:
getResourceAsStream
in interfaceBeanContext
- Parameters:
name
- the name of the resource requested.bcc
- the child object making the request.- Returns:
- the requested resource as an InputStream
- Throws:
NullPointerException
- if the argument is null
-
getResource
Description copied from interface:BeanContext
Analogous tojava.lang.ClassLoader.getResource()
, this method allows aBeanContext
implementation to interpose behavior between the childComponent
and underlyingClassLoader
.- Specified by:
getResource
in interfaceBeanContext
- Parameters:
name
- the name of the resource requested.bcc
- the child object making the request.- Returns:
- the requested resource as an InputStream
-
setDesignTime
public void setDesignTime(boolean dTime) Sets the new design time value for thisBeanContext
.- Specified by:
setDesignTime
in interfaceDesignMode
- Parameters:
dTime
- the new designTime value- See Also:
-
isDesignTime
public boolean isDesignTime()Reports whether or not this object is in currently in design time mode.- Specified by:
isDesignTime
in interfaceDesignMode
- Returns:
true
if in design time mode,false
if not
-
setLocale
Sets the locale of this BeanContext.- Parameters:
newLocale
- the new locale. This method call will have no effect if newLocale isnull
.- Throws:
PropertyVetoException
- if the new value is rejected
-
getLocale
Gets the locale for thisBeanContext
.- Returns:
- the current Locale of the
BeanContext
-
needsGui
public boolean needsGui()This method is typically called from the environment in order to determine if the implementor "needs" a GUI.
The algorithm used herein tests the BeanContextPeer, and its current children to determine if they are either Containers, Components, or if they implement Visibility and return needsGui() == true.
- Specified by:
needsGui
in interfaceVisibility
- Returns:
true
if the implementor needs a GUI
-
dontUseGui
public void dontUseGui()notify this instance that it may no longer render a GUI.- Specified by:
dontUseGui
in interfaceVisibility
-
okToUseGui
public void okToUseGui()Notify this instance that it may now render a GUI- Specified by:
okToUseGui
in interfaceVisibility
-
avoidingGui
public boolean avoidingGui()Used to determine if theBeanContext
child is avoiding using its GUI.- Specified by:
avoidingGui
in interfaceVisibility
- Returns:
- is this instance avoiding using its GUI?
- See Also:
-
isSerializing
public boolean isSerializing()Is thisBeanContext
in the process of being serialized?- Returns:
true
if thisBeanContext
is currently being serialized, otherwisefalse
-
bcsChildren
Returns an iterator of all children of thisBeanContext
.- Returns:
- an iterator for all the current BCSChild values
-
bcsPreSerializationHook
called by writeObject after defaultWriteObject() but prior to serialization of currently serializable children. This method may be overridden by subclasses to perform custom serialization of their state prior to this superclass serializing the children. This method should not however be used by subclasses to replace their own implementation (if any) of writeObject().- Parameters:
oos
- theObjectOutputStream
to use during serialization- Throws:
IOException
- if serialization failed
-
bcsPreDeserializationHook
protected void bcsPreDeserializationHook(ObjectInputStream ois) throws IOException, ClassNotFoundException called by readObject after defaultReadObject() but prior to deserialization of any children. This method may be overridden by subclasses to perform custom deserialization of their state prior to this superclass deserializing the children. This method should not however be used by subclasses to replace their own implementation (if any) of readObject().- Parameters:
ois
- theObjectInputStream
to use during deserialization- Throws:
IOException
- if deserialization failedClassNotFoundException
- if needed classes are not found
-
childDeserializedHook
Called by readObject with the newly deserialized child and BCSChild.- Parameters:
child
- the newly deserialized childbcsc
- the newly deserialized BCSChild
-
serialize
Used by writeObject to serialize a Collection.- Parameters:
oos
- theObjectOutputStream
to use during serializationcoll
- theCollection
to serialize- Throws:
IOException
- if serialization failed
-
deserialize
protected final void deserialize(ObjectInputStream ois, Collection coll) throws IOException, ClassNotFoundException used by readObject to deserialize a collection.- Parameters:
ois
- the ObjectInputStream to usecoll
- the Collection- Throws:
IOException
- if deserialization failedClassNotFoundException
- if needed classes are not found
-
writeChildren
Used to serialize all children of thisBeanContext
.- Parameters:
oos
- theObjectOutputStream
to use during serialization- Throws:
IOException
- if serialization failed
-
readChildren
When an instance of this class is used as a delegate for the implementation of the BeanContext protocols (and its subprotocols) there exists a 'chicken and egg' problem during deserialization- Parameters:
ois
- the ObjectInputStream to use- Throws:
IOException
- if deserialization failedClassNotFoundException
- if needed classes are not found
-
vetoableChange
subclasses may envelope to monitor veto child property changes.- Specified by:
vetoableChange
in interfaceVetoableChangeListener
- Parameters:
pce
- aPropertyChangeEvent
object describing the event source and the property that has changed.- Throws:
PropertyVetoException
- if the recipient wishes the property change to be rolled back.
-
propertyChange
subclasses may envelope to monitor child property changes.- Specified by:
propertyChange
in interfacePropertyChangeListener
- Parameters:
pce
- A PropertyChangeEvent object describing the event source and the property that has changed.
-
validatePendingAdd
Subclasses of this class may override, or envelope, this method to add validation behavior for the BeanContext to examine child objects immediately prior to their being added to the BeanContext.
- Parameters:
targetChild
- the child to create the Child on behalf of- Returns:
- true iff the child may be added to this BeanContext, otherwise false.
-
validatePendingRemove
Subclasses of this class may override, or envelope, this method to add validation behavior for the BeanContext to examine child objects immediately prior to their being removed from the BeanContext.
- Parameters:
targetChild
- the child to create the Child on behalf of- Returns:
- true iff the child may be removed from this BeanContext, otherwise false.
-
childJustAddedHook
subclasses may override this method to simply extend add() semantics after the child has been added and before the event notification has occurred. The method is called with the child synchronized.- Parameters:
child
- the childbcsc
- the BCSChild
-
childJustRemovedHook
subclasses may override this method to simply extend remove() semantics after the child has been removed and before the event notification has occurred. The method is called with the child synchronized.- Parameters:
child
- the childbcsc
- the BCSChild
-
getChildVisibility
Gets the Component (if any) associated with the specified child.- Parameters:
child
- the specified child- Returns:
- the Component (if any) associated with the specified child.
-
getChildSerializable
Gets the Serializable (if any) associated with the specified Child- Parameters:
child
- the specified child- Returns:
- the Serializable (if any) associated with the specified Child
-
getChildPropertyChangeListener
Gets the PropertyChangeListener (if any) of the specified child- Parameters:
child
- the specified child- Returns:
- the PropertyChangeListener (if any) of the specified child
-
getChildVetoableChangeListener
Gets the VetoableChangeListener (if any) of the specified child- Parameters:
child
- the specified child- Returns:
- the VetoableChangeListener (if any) of the specified child
-
getChildBeanContextMembershipListener
protected static final BeanContextMembershipListener getChildBeanContextMembershipListener(Object child) Gets the BeanContextMembershipListener (if any) of the specified child- Parameters:
child
- the specified child- Returns:
- the BeanContextMembershipListener (if any) of the specified child
-
getChildBeanContextChild
Gets the BeanContextChild (if any) of the specified child- Parameters:
child
- the specified child- Returns:
- the BeanContextChild (if any) of the specified child
- Throws:
IllegalArgumentException
- if child implements both BeanContextChild and BeanContextProxy
-
fireChildrenAdded
Fire a BeanContextMembershipEvent on the BeanContextMembershipListener interface- Parameters:
bcme
- the event to fire
-
fireChildrenRemoved
Fire a BeanContextMembershipEvent on the BeanContextMembershipListener interface- Parameters:
bcme
- the event to fire
-
initialize
protected void initialize()protected method called from constructor and readObject to initialize transient state of BeanContextSupport instance. This class uses this method to instantiate inner class listeners used to monitor PropertyChange and VetoableChange events on children. subclasses may envelope this method to add their own initialization behavior -
copyChildren
Gets a copy of the this BeanContext's children.- Returns:
- a copy of the current nested children
-
classEquals
-