ControlBeanContext (Apache Beehive Controls API Documentation (Version 1.0.2))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.controls.runtime.bean
Class ControlBeanContext

Object
  ControlBeanContext

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

Direct Known Subclasses:: ControlContainerContext

public class ControlBeanContext
extends Object
implements ControlBeanContext, PropertyChangeListener, VetoableChangeListener, Serializable
extends Object
implements ControlBeanContext, PropertyChangeListener, VetoableChangeListener, Serializable

The ControlBeanContext implements the basic BeanContextServices implementation for ControlBeans. It provides several basic functions: - it defines the generic services that are available for all control containers - it acts as the base class for other container service implementations - it acts as the BeanContextServicesRevokedListener when an associated control bean has lost access to services.

See Also:: Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ControlBeanContext
`ControlBeanContext.LifeCycle`

Field Summary

Fields inherited from interface BeanContext
`globalHierarchyLock`

Fields inherited from interface DesignMode
`PROPERTYNAME`

Constructor Summary
`protected`	`ControlBeanContext(ControlBean bean)` Creates a new ControlBeanContext instance associated with a specific control bean.
`protected`	`ControlBeanContext(ControlBean bean, ControlBeanContext.BeanContextServicesFactory beanContextServicesFactory)` Creates a new ControlBeanContext instance associated with a specific control bean.

Method Summary

boolean add(Object targetChild)
Overrides the BeanContextSupport.add() method to perform additional validation that is unique for ControlBeans containers.

boolean addAll(Collection c)

void addBeanContextMembershipListener(BeanContextMembershipListener bcml)

void addBeanContextServicesListener(BeanContextServicesListener bcsl)

void addLifeCycleListener(ControlBeanContext.LifeCycle listener)
Registers a new listener for LifeCycle events on the context.

void addPropertyChangeListener(String name, PropertyChangeListener pcl)

boolean addService(Class serviceClass, BeanContextServiceProvider serviceProvider)

void addVetoableChangeListener(String name, VetoableChangeListener vcl)

boolean avoidingGui()

void clear()

boolean contains(Object o)

boolean containsAll(Collection c)

void dontUseGui()

boolean equals(Object o)

String generateUniqueID(Class clazz)
Generates a new unique control ID for an instance of the target class

PropertyMap getAnnotationMap(AnnotatedElement annotElem)
Returns the PropertyMap containing default properties for an AnnotatedElement in the current context.

ControlBean getBean(String id)
Returns a ControlBean instance nested the current BeanContext.

protected PropertyMap getBeanAnnotationMap(ControlBean bean, AnnotatedElement annotElem)
The default implementation of getBeanAnnotationMap.

BeanContext getBeanContext()

protected ControlBeanContext.BeanContextServicesFactory getBeanContextServicesFactory()

ClassLoader getClassLoader()
Returns the ClassLoader used to load the ControlBean class associated with the control implementation instance.

ControlBean getControlBean()
Returns the ControlBean associated directly with the ControlBeanContext.

ControlHandle getControlHandle()
Returns a ControlHandle instance that enables operations and events to be dispatched to the target control, if it is running inside of a container that supports external event dispatch.

Class getControlInterface()
Returns the public or extension interface associated with the context

PropertyMap getControlPropertyMap()
Returns the current set of properties (in PropertyMap format) for the control associated with the context.





<T extends Annotation> 


T

getControlPropertySet(Class<T> propertySet)
Returns the current value of PropertySet for the associated control, or null if the property set has not been bound.

Iterator getCurrentServiceClasses()

Iterator getCurrentServiceSelectors(Class serviceClass)

static String getDefaultControlBinding(Class controlIntf)
Deprecated. Use ControlUtils.getDefaultControlBinding(Class) insated. This method will be removed in the next point release.





<T extends Annotation> 


T

getMethodPropertySet(Method m,
                     Class<T> propertySet)

Returns the current value of PropertySet for the provided method, or null if the property set has not been bound for this method.

String[] getParameterNames(Method m)
Returns an array containing the parameter names for the specified method





<T extends Annotation> 


T

getParameterPropertySet(Method m,
                        int i,
                        Class<T> propertySet)

Returns the current value of PropertySet for the selected (by index) method parameter, or null if the property set has not been bound for this method.

Object getParameterValue(Method m, String parameterName, Object[] parameters)
Returns the value of a named method parameter from the input parameter array.

URL getResource(String name, BeanContextChild bcc)

InputStream getResourceAsStream(String name, BeanContextChild bcc)

Object getService(BeanContextChild child, Object requestor, Class serviceClass, Object serviceSelector, BeanContextServiceRevokedListener bcsrl)





<T> T

getService(Class<T> serviceClass,
           Object selector)

Returns an instance of a contextual service based upon the local context.

int hashCode()

boolean hasService(Class serviceClass)

boolean hasSingleThreadedParent()

void initialize()
Called by BeanContextSupport superclass during construction and deserialization to initialize subclass transient state

void initializeControl()
The initializeControl method is invoked when the implementation instance associated with the context has been instantiated and initialized.

Object instantiateChild(String beanName)

boolean isDesignTime()

boolean isEmpty()

boolean isSingleThreadedContainer()
Returns true if this container associated with this context service enforces single-threaded invocation, false otherwise.

Iterator iterator()

boolean needsGui()

void okToUseGui()

static String[] prioritizeInterceptors(String[] interceptors)
Deprecated. Use InterceptorUtils.prioritizeInterceptors(String[]) instead. This method will be removed in the next point release.

void propertyChange(PropertyChangeEvent pce)

void releaseService(BeanContextChild child, Object requestor, Object service)

boolean remove(Object targetChild)
Overrides the BeanContextSupport.remove() method to perform additional post-processing on child removal.

boolean removeAll(Collection c)

void removeBeanContextMembershipListener(BeanContextMembershipListener bcml)

void removeBeanContextServicesListener(BeanContextServicesListener bcsl)

void removeLifeCycleListener(ControlBeanContext.LifeCycle listener)
Removes a currently registered LifeCycle event listener on the context.

void removePropertyChangeListener(String name, PropertyChangeListener pcl)

void removeVetoableChangeListener(String name, VetoableChangeListener vcl)

static String resolveDefaultBinding(String implBinding, String controlClass)
Deprecated. Use ControlUtils.resolveDefaultBinding(String, String) insated. This method will be removed in the next point release.

boolean retainAll(Collection c)

void revokeService(Class serviceClass, BeanContextServiceProvider serviceProvider, boolean revokeCurrentServicesNow)

void serviceAvailable(BeanContextServiceAvailableEvent bcsae)

void serviceRevoked(BeanContextServiceRevokedEvent bcsre)
Implements the BeanContextServiceRevokedListener.serviceRevoked(java.beans.beancontext.BeanContextServiceRevokedEvent) method.

void setBeanContext(BeanContext beanContext)
Overrides the BeanContextChild.setBeanContext(java.beans.beancontext.BeanContext) method.

protected static void setDelegateMap(PropertyMap map, ControlBean bean, AnnotatedElement annotElem)

void setDesignTime(boolean designTime)

int size()

Object[] toArray()

Object[] toArray(Object[] a)

void vetoableChange(PropertyChangeEvent pce)

Methods inherited from class Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ControlBeanContext

protected ControlBeanContext(ControlBean bean)

Creates a new ControlBeanContext instance associated with a specific control bean. If the ControlBean is null, this ControlBeanContext object represents a top-level Control container. This constructor uses the default implementation of the BeanContextServices interface from the JDK.

Parameters:: bean - The control bean that contains/scopes the ControlBeanContext. If null, it means the ControlBeanContext is for a top-level container.

ControlBeanContext

protected ControlBeanContext(ControlBean bean,
                             ControlBeanContext.BeanContextServicesFactory beanContextServicesFactory)

Creates a new ControlBeanContext instance associated with a specific control bean. If the ControlBean is null, this ControlBeanContext object represents a top-level Control container. This constructor uses the beanContextServicesDelegate instance as the implementation of the BeanContextServices interface.

Parameters:: bean - The control bean; beanContextServicesFactory - A factory that can be used to create the BeanContextServicesFactory object that implements support for the BeanContextServices interface.

Method Detail

initialize

public void initialize()

Called by BeanContextSupport superclass during construction and deserialization to initialize subclass transient state

serviceRevoked

public void serviceRevoked(BeanContextServiceRevokedEvent bcsre)

Implements the BeanContextServiceRevokedListener.serviceRevoked(java.beans.beancontext.BeanContextServiceRevokedEvent) method. This is called if the associated ControlBean has requested a service that is being subsequently revoked.

Specified by:: serviceRevoked in interface BeanContextServiceRevokedListener

setBeanContext

public void setBeanContext(BeanContext beanContext)
                    throws PropertyVetoException

Overrides the BeanContextChild.setBeanContext(java.beans.beancontext.BeanContext) method. This hook is used to perform additional processing that needs to occur when the control is associated with a new nesting context.

Specified by:: setBeanContext in interface BeanContextChild

Throws:: PropertyVetoException

generateUniqueID

public String generateUniqueID(Class clazz)

Generates a new unique control ID for an instance of the target class

add

public boolean add(Object targetChild)

Overrides the BeanContextSupport.add() method to perform additional validation that is unique for ControlBeans containers.

Specified by:: add in interface Collection

remove

public boolean remove(Object targetChild)

Overrides the BeanContextSupport.remove() method to perform additional post-processing on child removal.

Specified by:: remove in interface Collection

getBean

public ControlBean getBean(String id)

Returns a ControlBean instance nested the current BeanContext.

Specified by:: getBean in interface ControlBeanContext

Parameters:: id - the identifier for the target control, relative to the current context.

getControlBean

public ControlBean getControlBean()

Returns the ControlBean associated directly with the ControlBeanContext. If the context represents a top-level container, will return null.

Specified by:: getControlBean in interface ControlBeanContext

hasSingleThreadedParent

public boolean hasSingleThreadedParent()

isSingleThreadedContainer

public boolean isSingleThreadedContainer()

Returns true if this container associated with this context service enforces single-threaded invocation, false otherwise. This MUST be overridden by container-specific subclasses in order to change the default behavior. If a single-threaded container intends to guarantee single-threaded behavior (such as the EJB container), this should return true.

Specified by:: isSingleThreadedContainer in interface ControlBeanContext

initializeControl

public void initializeControl()

The initializeControl method is invoked when the implementation instance associated with the context has been instantiated and initialized.

getAnnotationMap

public PropertyMap getAnnotationMap(AnnotatedElement annotElem)

Returns the PropertyMap containing default properties for an AnnotatedElement in the current context. The initialization of PropertyMap binding is always done by delegating to a ControlContainerContext, enabling containers to implement property binding mechanisms (such as external config) that may override the values contained within the element annotations.

Specified by:: getAnnotationMap in interface ControlBeanContext

getBeanAnnotationMap

protected PropertyMap getBeanAnnotationMap(ControlBean bean,
                                           AnnotatedElement annotElem)

The default implementation of getBeanAnnotationMap. This returns a map based purely upon annotation reflection