jadex.commons.beans.beancontext

Class BeanContextSupport

java.lang.Object

jadex.commons.beans.beancontext.BeanContextChildSupport

jadex.commons.beans.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

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

Field Summary

Fields inherited from class jadex.commons.beans.beancontext.BeanContextChildSupport

beanContextChildPeer

Fields inherited from interface jadex.commons.beans.beancontext.BeanContext

globalHierarchyLock

Fields inherited from interface jadex.commons.beans.DesignMode

PROPERTYNAME

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
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()
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.
void	dontUseGui()
BeanContext	getBeanContextPeer() Returns the peer of this context casted as BeanContext.
Locale	getLocale() Returns the locale of this context.
URL	getResource(String resourceName, BeanContextChild child)
InputStream	getResourceAsStream(String resourceName, BeanContextChild child)
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.
boolean	removeAll(Collection collection) This method is unsupported, throws UnsupportedOperationException.
void	removeBeanContextMembershipListener(BeanContextMembershipListener listener)
boolean	retainAll(Collection collection) This method is unsupported, throws UnsupportedOperationException.
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.
void	vetoableChange(PropertyChangeEvent pce)
void	writeChildren(ObjectOutputStream oos) Serializes children to the given object input stream.

Methods inherited from class jadex.commons.beans.beancontext.BeanContextChildSupport

addPropertyChangeListener, addVetoableChangeListener, firePropertyChange, fireVetoableChange, getBeanContext, getBeanContextChildPeer, isDelegated, removePropertyChangeListener, removeVetoableChangeListener, serviceAvailable, serviceRevoked, setBeanContext, validatePendingSetBeanContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jadex.commons.beans.beancontext.BeanContextChild

addPropertyChangeListener, addVetoableChangeListener, getBeanContext, removePropertyChangeListener, removeVetoableChangeListener, setBeanContext

Methods inherited from interface java.util.Collection

equals, hashCode

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

clear

public void clear()

This method is unsupported, throws UnsupportedOperationException.

Specified by:

clear in interface Collection

See Also:

Collection.clear()

contains

public boolean contains(Object child)

Returns true if the given object is a child of this context.

Specified by:

contains in interface Collection

Parameters:

child - the object to test

Returns:

true if the given object is a child of this context

See Also:

Collection.contains(java.lang.Object)

containsAll

public boolean containsAll(Collection collection)

Returns true if given objects are children of this context.

Specified by:

containsAll in interface Collection

Parameters:

collection - a collection of objects

Returns:

true if given objects are children of this context

See Also:

Collection.containsAll(java.util.Collection)

containsKey

public boolean containsKey(Object child)

Returns true if the given object is a child of this context.

Parameters:

child - the object to test

Returns:

true if the given object is a child of this context

dontUseGui

public void dontUseGui()

Specified by:

dontUseGui in interface Visibility

getBeanContextPeer

public BeanContext getBeanContextPeer()

Returns the peer of this context casted as BeanContext.

Returns:

the peer of this context casted as BeanContext

getLocale

public Locale getLocale()

Returns the locale of this context.

Returns:

the locale of this context

getResource

public URL getResource(String resourceName,
              BeanContextChild child)

Specified by:

getResource in interface BeanContext

getResourceAsStream

public InputStream getResourceAsStream(String resourceName,
                              BeanContextChild child)
                                throws IllegalArgumentException

Specified by:

getResourceAsStream in interface BeanContext

Throws:

IllegalArgumentException

instantiateChild

public Object instantiateChild(String beanName)
                        throws IOException,
                               ClassNotFoundException

Specified by:

instantiateChild in interface BeanContext

Throws:

IOException

ClassNotFoundException

isDesignTime

public boolean isDesignTime()

Specified by:

isDesignTime in interface DesignMode

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

isSerializing

public boolean isSerializing()

Returns true if this context is currently being serialized (by another thread).

Returns:

true if this context is currently being serialized (by another thread)

iterator

public Iterator iterator()

Returns an iterator of children of this context, with remove() disabled.

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

See Also:

Collection.iterator()

needsGui

public boolean needsGui()

Returns true if this context or its children needs GUI to work properly.

The implementation checks the peer and all the children that implement Visibility to see if any of their needsGui() returns true, and if any of the children extends java.awt.Component.

Specified by:

needsGui in interface Visibility

See Also:

Visibility.needsGui()

okToUseGui

public void okToUseGui()

Specified by:

okToUseGui in interface Visibility

propertyChange

public void propertyChange(PropertyChangeEvent event)

Specified by:

propertyChange in interface PropertyChangeListener

readChildren

public final void readChildren(ObjectInputStream ois)
                        throws IOException,
                               ClassNotFoundException

Deserializes children from the given object input stream.

The implementation reads pairs of child object and BCSChild object according to serializable property. For each pair, it is added to the children map and the childDeserializedHook() is called. If the child implements BeanContextChild, its setBeanContext() is also called.

This method is called by readObject() if the context works standalone. Or if this support object is a delegate of another BeanContext implementation, then this method should be called by the peer. Doing this means that derialization can proceed without any circular dependency problems.

Parameters:

ois - the object input stream

Throws:

IOException - if I/O exception occurs

ClassNotFoundException - if class of read object is not found

remove

public boolean remove(Object child)

Removes the given child from this context.

Delegates to remove(child, true).

Specified by:

remove in interface Collection

Parameters:

child - a child of this context

Returns:

true if the child is removed; or false if it is not a child of this context

Throws:

IllegalArgumentException - if the child is null

IllegalStateException - if the child is not valid to remove

See Also:

Collection.remove(java.lang.Object)

removeAll

public boolean removeAll(Collection collection)

This method is unsupported, throws UnsupportedOperationException.

Specified by:

removeAll in interface Collection

See Also:

Collection.removeAll(java.util.Collection)

removeBeanContextMembershipListener

public void removeBeanContextMembershipListener(BeanContextMembershipListener listener)

Specified by:

removeBeanContextMembershipListener in interface BeanContext

retainAll

public boolean retainAll(Collection collection)

This method is unsupported, throws UnsupportedOperationException.

Specified by:

retainAll in interface Collection

See Also:

Collection.retainAll(java.util.Collection)

setDesignTime

public void setDesignTime(boolean designTime)

Specified by:

setDesignTime in interface DesignMode

setLocale

public void setLocale(Locale newLocale)
               throws PropertyVetoException

Sets the locale of this context. VetoableChangeListeners and PropertyChangeListeners are notified.

Parameters:

newLocale - the new locale to set

Throws:

PropertyVetoException - if any VetoableChangeListener vetos this change

size

public int size()

Returns the number children of this context.

Specified by:

size in interface Collection

Returns:

the number children of this context

See Also:

Collection.size()

toArray

public Object[] toArray()

Returns an array of children of this context.

Specified by:

toArray in interface Collection

Returns:

an array of children of this context

See Also:

Collection.toArray()

toArray

public Object[] toArray(Object[] array)

Returns an array of children of this context.

Specified by:

toArray in interface Collection

Returns:

an array of children of this context

See Also:

Collection.toArray(java.lang.Object[])

vetoableChange

public void vetoableChange(PropertyChangeEvent pce)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface VetoableChangeListener

Throws:

PropertyVetoException

writeChildren

public final void writeChildren(ObjectOutputStream oos)
                         throws IOException

Serializes children to the given object input stream.

The implementation iterates through all children and writes out pairs of child object and BCSChild object if the child is serializable (implements Serialization.

This method is called by writeObject() if the context works standalone. Or if this support object is a delegate of another BeanContext implementation, then this method should be called by the peer to avoid the 'chicken and egg' problem during deserialization.

Parameters:

oos - the stream to write

Throws:

IOException - if I/O exception occurs