BeanContextSupport (App55 Library for Java 0.8.6 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.googlecode.openbeans.beancontext
Class BeanContextSupport

java.lang.Object
  com.googlecode.openbeans.beancontext.BeanContextChildSupport
      com.googlecode.openbeans.beancontext.BeanContextSupport

All Implemented Interfaces:: BeanContext, BeanContextChild, BeanContextServiceRevokedListener, BeanContextServicesListener, DesignMode, PropertyChangeListener, VetoableChangeListener, Visibility, Serializable, Iterable, Collection, EventListener

Direct Known Subclasses:: BeanContextServicesSupport

public class BeanContextSupport
extends BeanContextChildSupport
implements BeanContext, PropertyChangeListener, VetoableChangeListener, Serializable
extends BeanContextChildSupport
implements BeanContext, PropertyChangeListener, VetoableChangeListener, Serializable

This support class implements BeanContext interface. This class can be used directly, or be a super class of your class, or be a delegate of your implementation that needs to support BeanContext interface.

See Also:: Serialized Form

Nested Class Summary
`protected class`	`BeanContextSupport.BCSChild` Every child of context is companied with a `BCSChild` instance.
`protected static class`	`BeanContextSupport.BCSIterator` This implementation wraps an iterator and override `remove()` with a noop method.

Field Summary
`protected ArrayList`	`bcmListeners` A list of registered membership listeners.
`protected HashMap`	`children` A map of children - key is child instance, value is `BCSChild` instance.
`protected boolean`	`designTime` A flag indicating whether this context is in design mode.
`protected Locale`	`locale` The locale of this context.
`protected boolean`	`okToUseGui` A flag indicating whether this context is allowed to use GUI.

Fields inherited from class com.googlecode.openbeans.beancontext.BeanContextChildSupport
`beanContext, beanContextChildPeer, pcSupport, rejectedSetBCOnce, vcSupport`

Fields inherited from interface com.googlecode.openbeans.beancontext.BeanContext
`globalHierarchyLock`

Fields inherited from interface com.googlecode.openbeans.DesignMode
`PROPERTYNAME`

Constructor Summary
`BeanContextSupport()` Constructs a standload `BeanContextSupport`.
`BeanContextSupport(BeanContext peer)` Constructs a `BeanContextSupport` which is a delegate of the given peer.
`BeanContextSupport(BeanContext peer, Locale locale)` Constructs a `BeanContextSupport` which is a delegate of the given peer.
`BeanContextSupport(BeanContext peer, Locale locale, boolean designTime)` Constructs a `BeanContextSupport` which is a delegate of the given peer.
`BeanContextSupport(BeanContext peer, Locale locale, boolean designTime, boolean okToUseGui)` Constructs a `BeanContextSupport` which is a delegate of the given peer.

Method Summary
`boolean`	`add(Object child)` Add a child to this context.
`boolean`	`addAll(Collection collection)` This method is unsupported, throws `UnsupportedOperationException`.
`void`	`addBeanContextMembershipListener(BeanContextMembershipListener listener)`
`boolean`	`avoidingGui()`
`protected Iterator`	`bcsChildren()` Returns an iterator of all `BCSChild` instances, with `remove()` disabled.
`protected void`	`bcsPreDeserializationHook(ObjectInputStream ois)` This method is called by `readObject()` after `defaultReadObject()` and before deserializing any children or listeners.
`protected void`	`bcsPreSerializationHook(ObjectOutputStream oos)` This method is called by `writeObject()` after `defaultWriteObject()` and before serializing any children or listeners.
`protected void`	`childDeserializedHook(Object child, BeanContextSupport.BCSChild bcsChild)` This method is called during deserialization everytime a child is read.
`protected void`	`childJustAddedHook(Object child, BeanContextSupport.BCSChild bcsChild)` This method is called everytime a child is added to this context.
`protected void`	`childJustRemovedHook(Object child, BeanContextSupport.BCSChild bcsChild)` This method is called everytime a child is removed from this context.
`protected static boolean`	`classEquals(Class clz1, Class clz2)` Compares if two classes are equal or their class names are equal.
`void`	`clear()` This method is unsupported, throws `UnsupportedOperationException`.
`boolean`	`contains(Object child)` Returns true if the given object is a child of this context.
`boolean`	`containsAll(Collection collection)` Returns true if given objects are children of this context.
`boolean`	`containsKey(Object child)` Returns true if the given object is a child of this context.
`protected Object[]`	`copyChildren()` Returns an array containing all children of this context.
`protected BeanContextSupport.BCSChild`	`createBCSChild(Object child, Object proxyPeer)` Creates a `BCSChild` object to company the given child.
`protected void`	`deserialize(ObjectInputStream ois, Collection collection)` Deserialize a collection.
`void`	`dontUseGui()`
`protected void`	`fireChildrenAdded(BeanContextMembershipEvent event)` Notifies registered `BeanContextMembershipListener`s that a new child has been added.
`protected void`	`fireChildrenRemoved(BeanContextMembershipEvent event)` Notifies registered `BeanContextMembershipListener`s that a child has been removed.
`BeanContext`	`getBeanContextPeer()` Returns the peer of this context casted as `BeanContext`.
`protected static BeanContextChild`	`getChildBeanContextChild(Object child)` Returns the `BeanContextChild` related with the given child.
`protected static BeanContextMembershipListener`	`getChildBeanContextMembershipListener(Object child)` Returns the given child casted to `BeanContextMembershipListener`, or null if it does not implements the interface.
`protected static PropertyChangeListener`	`getChildPropertyChangeListener(Object child)` Returns the given child casted to `PropertyChangeListener`, or null if it does not implements the interface.
`protected static Serializable`	`getChildSerializable(Object child)` Returns the given child casted to `Serializable`, or null if it does not implements the interface.
`protected static VetoableChangeListener`	`getChildVetoableChangeListener(Object child)` Returns the given child casted to `VetoableChangeListener`, or null if it does not implements the interface.
`protected static Visibility`	`getChildVisibility(Object child)` Returns the given child casted to `Visibility`, or null if it does not implements the interface.
`Locale`	`getLocale()` Returns the locale of this context.
`URL`	`getResource(String resourceName, BeanContextChild child)`
`InputStream`	`getResourceAsStream(String resourceName, BeanContextChild child)`
`protected void`	`initialize()` Initializes all transient fields of this instance, called by constructors and `readObject()`.
`Object`	`instantiateChild(String beanName)`
`boolean`	`isDesignTime()`
`boolean`	`isEmpty()`
`boolean`	`isSerializing()` Returns true if this context is currently being serialized (by another thread).
`Iterator`	`iterator()` Returns an iterator of children of this context, with `remove()` disabled.
`boolean`	`needsGui()` Returns true if this context or its children needs GUI to work properly.
`void`	`okToUseGui()`
`void`	`propertyChange(PropertyChangeEvent event)`
`void`	`readChildren(ObjectInputStream ois)` Deserializes children from the given object input stream.
`boolean`	`remove(Object child)` Removes the given child from this context.
`protected boolean`	`remove(Object child, boolean setChildBC)` Removes the given child from this context.
`boolean`	`removeAll(Collection collection)` This method is unsupported, throws `UnsupportedOperationException`.
`void`	`removeBeanContextMembershipListener(BeanContextMembershipListener listener)`
`boolean`	`retainAll(Collection collection)` This method is unsupported, throws `UnsupportedOperationException`.
`protected void`	`serialize(ObjectOutputStream oos, Collection collection)` Serializes the given collection.
`void`	`setDesignTime(boolean designTime)`
`void`	`setLocale(Locale newLocale)` Sets the locale of this context.
`int`	`size()` Returns the number children of this context.
`Object[]`	`toArray()` Returns an array of children of this context.
`Object[]`	`toArray(Object[] array)` Returns an array of children of this context.
`protected boolean`	`validatePendingAdd(Object child)` Validates the pending add of child.
`protected boolean`	`validatePendingRemove(Object child)` Validates the pending removal of child.
`void`	`vetoableChange(PropertyChangeEvent pce)`
`void`	`writeChildren(ObjectOutputStream oos)` Serializes children to the given object input stream.

Methods inherited from class com.googlecode.openbeans.beancontext.BeanContextChildSupport
`addPropertyChangeListener, addVetoableChangeListener, firePropertyChange, fireVetoableChange, getBeanContext, getBeanContextChildPeer, initializeBeanContextResources, isDelegated, releaseBeanContextResources, removePropertyChangeListener, removeVetoableChangeListener, serviceAvailable, serviceRevoked, setBeanContext, validatePendingSetBeanContext`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.googlecode.openbeans.beancontext.BeanContextChild
`addPropertyChangeListener, addVetoableChangeListener, getBeanContext, removePropertyChangeListener, removeVetoableChangeListener, setBeanContext`

Methods inherited from interface java.util.Collection
`equals, hashCode`

Field Detail

bcmListeners

protected transient ArrayList bcmListeners

A list of registered membership listeners. All access to this object should be synchronized on itself.

children

protected transient HashMap children

A map of children - key is child instance, value is BCSChild instance. All access to this object should be synchronized on itself.

locale

protected Locale locale

The locale of this context.

okToUseGui

protected boolean okToUseGui

A flag indicating whether this context is allowed to use GUI.

designTime

protected boolean designTime

A flag indicating whether this context is in design mode.

Constructor Detail

BeanContextSupport

public BeanContextSupport()

Constructs a standload BeanContextSupport.

BeanContextSupport

public BeanContextSupport(BeanContext peer)

Constructs a BeanContextSupport which is a delegate of the given peer.

Parameters:: peer - the peer of this context

BeanContextSupport

public BeanContextSupport(BeanContext peer,
                          Locale locale)

Constructs a BeanContextSupport which is a delegate of the given peer.

Parameters:: peer - the peer of this context; locale - the locale of this context

BeanContextSupport

public BeanContextSupport(BeanContext peer,
                          Locale locale,
                          boolean designTime)

Constructs a BeanContextSupport which is a delegate of the given peer.

Parameters:: peer - the peer of this context; locale - the locale of this context; designTime - whether in design mode or not

BeanContextSupport

public BeanContextSupport(BeanContext peer,
                          Locale locale,
                          boolean designTime,
                          boolean okToUseGui)

Constructs a BeanContextSupport which is a delegate of the given peer.

Parameters:: peer - the peer of this context; locale - the locale of this context; designTime - whether in design mode or not; okToUseGui - whether GUI is usable or not

Method Detail

add

public boolean add(Object child)

Add a child to this context.

If the child already exists in this context, simply returns false. Otherwise, it is validated by calling validatePendingAdd(). If the add is valid, the child and its proxy (if the child implements BeanContextProxy) is then added, and setBeanContext() is called on it (if the child implements BeanContextChild or it has a proxy). Last, the childJustAddedHook() is called and all registered BeanContextMembershipListeners are notified.

Specified by:: add in interface Collection

Parameters:: child - the child to add
Returns:: true if the child is added to this context; otherwise false
Throws:: IllegalStateException - if the child is not valid to add
See Also:: Collection.add(java.lang.Object)

addAll

public boolean addAll(Collection collection)

This method is unsupported, throws UnsupportedOperationException.

Specified by:: addAll in interface Collection

See Also:: Collection.addAll(java.util.Collection)

addBeanContextMembershipListener

public void addBeanContextMembershipListener(BeanContextMembershipListener listener)

Specified by:: addBeanContextMembershipListener in interface BeanContext

avoidingGui

public boolean avoidingGui()

Specified by:: avoidingGui in interface Visibility

bcsChildren

protected Iterator bcsChildren()

Returns an iterator of all BCSChild instances, with remove() disabled.

Returns:: an iterator of all BCSChild instances

bcsPreDeserializationHook

protected void bcsPreDeserializationHook(ObjectInputStream ois)
                                  throws IOException,
                                         ClassNotFoundException

This method is called by readObject() after defaultReadObject() and before deserializing any children or listeners. Subclass can insert its specific deserialization behavior by overrideing this method.