cern::gp::beans::BeanTagger Class Reference

Collaboration diagram for cern::gp::beans::BeanTagger:

[legend]

List of all members.

Static Public Member Functions
static void	setCacheable (FeatureDescriptor featureDescriptor, boolean cacheable)
static Boolean	isCacheable (FeatureDescriptor featureDescriptor)
static void	setExpandable (FeatureDescriptor featureDescriptor, boolean expandable)
static boolean	isExpandable (FeatureDescriptor featureDescriptor)
static void	setDefaultAction (FeatureDescriptor featureDescriptor, String defaultAction)
static void	setDefaultAction (BeanInfo beanInfo, String defaultAction)
static String	getDefaultAction (FeatureDescriptor featureDescriptor)
static String	getDefaultAction (BeanInfo beanInfo)
static void	addActions (FeatureDescriptor featureDescriptor, String[] actions)
static String[]	getActions (FeatureDescriptor featureDescriptor)
static String[]	getActions (BeanInfo beanInfo)
static void	addActions (BeanInfo beanInfo, String[] actions)
Private Member Functions
	BeanTagger ()
Static Private Member Functions
static final boolean	getBooleanValue (FeatureDescriptor featureDescriptor, String property)
static final void	setBooleanValue (FeatureDescriptor featureDescriptor, String property, boolean value)
static final boolean	doesActionExist (String[] actions, String action)
Static Private Attributes
static final String	IS_CACHEABLE_PROPERTY_NAME = "beantagger.isCacheable"
static final String	IS_EXPANDABLE_PROPERTY_NAME = "beantagger.isExpandable"
static final String	ACTIONS_PROPERTY_NAME = "beantagger.actions"
static final String	DEFAULT_ACTION_PROPERTY_NAME = "beantagger.defaultAction"
static final String	EMPTY_STRING = ""

---

Detailed Description

Utility class that can tag a Property or a BeanInfo to add information to it. The available static methods describe what information it is possible to add.

Version:

Revision

1.2

Date

2006/09/25 08:52:36

Author:

Lionel Mestre

---

Constructor & Destructor Documentation

cern::gp::beans::BeanTagger::BeanTagger

(

)

[inline, private]

prevent the creation of an new instance

---

Member Function Documentation

static void cern::gp::beans::BeanTagger::addActions	(	BeanInfo	beanInfo,
		String[]	actions
	)			[inline, static]

Adds classes of available actions to this BeanInfo. If the BeanInfo already defines some actions the existing ones and the new ones are merged together.

Parameters:

actionClasses

an array of the class of available action(s)

References addActions().

static void cern::gp::beans::BeanTagger::addActions	(	FeatureDescriptor	featureDescriptor,
		String[]	actions
	)			[inline, static]

Adds classes of available actions to this descriptor. If the featureDescriptor already defines some actions the existing ones and the new ones are merged together.

Parameters:

actionClasses

an array of the class of available action(s)

References ACTIONS_PROPERTY_NAME, doesActionExist(), EMPTY_STRING, and getActions().

Referenced by addActions().

static final boolean cern::gp::beans::BeanTagger::doesActionExist	(	String[]	actions,
		String	action
	)			[inline, static, private]

Referenced by addActions().

static String [] cern::gp::beans::BeanTagger::getActions

(

BeanInfo

beanInfo

)

[inline, static]

Gets the class of available actions for this BeanInfo

Returns:

an array of class of available actions for this BeanInfo

References getActions().

static String [] cern::gp::beans::BeanTagger::getActions

(

FeatureDescriptor

featureDescriptor

)

[inline, static]

Gets the class of available actions for this descriptor

Returns:

an array of class of available actions for this descriptor

References ACTIONS_PROPERTY_NAME.

Referenced by addActions(), and getActions().

static final boolean cern::gp::beans::BeanTagger::getBooleanValue	(	FeatureDescriptor	featureDescriptor,
		String	property
	)			[inline, static, private]

Referenced by isExpandable().

static String cern::gp::beans::BeanTagger::getDefaultAction

(

BeanInfo

beanInfo

)

[inline, static]

Gets the default action qualified name for this BeanInfo

Parameters:

beanInfo

the BeanInfo to get the default action from

Returns:

the qualified name of the default action or null is not specified

References getDefaultAction().

static String cern::gp::beans::BeanTagger::getDefaultAction

(

FeatureDescriptor

featureDescriptor

)

[inline, static]

Gets the default action qualified name for this FeatureDescriptor

Parameters:

featureDescriptor

the FeatureDescriptor to get the default action from

Returns:

the qualified name of the default action or null is not specified

References DEFAULT_ACTION_PROPERTY_NAME.

Referenced by getDefaultAction().

static Boolean cern::gp::beans::BeanTagger::isCacheable

(

FeatureDescriptor

featureDescriptor

)

[inline, static]

Checks if the given FeatureDescriptor is cacheable

Returns:

true if and only if this FeatureDescriptor is cacheable.

References IS_CACHEABLE_PROPERTY_NAME.

static boolean cern::gp::beans::BeanTagger::isExpandable

(

FeatureDescriptor

featureDescriptor

)

[inline, static]

Checks if this FeatureDescriptor is expandable which neams that it can be expanded into a list of more FeatureDescriptors

Returns:

true if and only if this FeatureDescriptor is expandable.

References getBooleanValue(), and IS_EXPANDABLE_PROPERTY_NAME.

static final void cern::gp::beans::BeanTagger::setBooleanValue	(	FeatureDescriptor	featureDescriptor,
		String	property,
		boolean	value
	)			[inline, static, private]

Referenced by setCacheable(), and setExpandable().

static void cern::gp::beans::BeanTagger::setCacheable	(	FeatureDescriptor	featureDescriptor,
		boolean	cacheable
	)			[inline, static]

Adds the information that this FeatureDescriptor is cacheable which neams that its value(s) can be cached. If it is a PropertyDescriptor it means that the value of the property can be cached. If it is a BeanDescriptor it means that all property values can be cached

Parameters:

	featureDescriptor	the FeatureDescriptor to tag as expandable.
	cacheable	whether the value(s) of the FeatureDescriptor can be cached or not

References IS_CACHEABLE_PROPERTY_NAME, and setBooleanValue().

static void cern::gp::beans::BeanTagger::setDefaultAction	(	BeanInfo	beanInfo,
		String	defaultAction
	)			[inline, static]

Sets the default action qualified name for this BeanInfo

Parameters:

	beanInfo	the BeanInfo to tag with the default action.
	defaultAction	the qualified name of the default action

References setDefaultAction().

static void cern::gp::beans::BeanTagger::setDefaultAction	(	FeatureDescriptor	featureDescriptor,
		String	defaultAction
	)			[inline, static]

Sets the default action qualified name for this FeatureDescriptor

Parameters:

	featureDescriptor	the FeatureDescriptor to tag with the default action
	defaultAction	the qualified name of the default action

References DEFAULT_ACTION_PROPERTY_NAME.

Referenced by setDefaultAction().

static void cern::gp::beans::BeanTagger::setExpandable	(	FeatureDescriptor	featureDescriptor,
		boolean	expandable
	)			[inline, static]

Adds the information that this FeatureDescriptor is expandable which neams that it can be expanded into a list of more FeatureDescriptors

Parameters:

	featureDescriptor	the FeatureDescriptor to tag as expandable.
	expandable	whether the FeatureDescriptor is expandable or not

References IS_EXPANDABLE_PROPERTY_NAME, and setBooleanValue().

---

Member Data Documentation

final String cern::gp::beans::BeanTagger::ACTIONS_PROPERTY_NAME = "beantagger.actions" [static, private]

name of property that is used to specify the qname of available actions

Referenced by addActions(), and getActions().

final String cern::gp::beans::BeanTagger::DEFAULT_ACTION_PROPERTY_NAME = "beantagger.defaultAction" [static, private]

name of property that is used to specify the qname of the default action

Referenced by getDefaultAction(), and setDefaultAction().

final String cern::gp::beans::BeanTagger::EMPTY_STRING = "" [static, private]

Referenced by addActions().

final String cern::gp::beans::BeanTagger::IS_CACHEABLE_PROPERTY_NAME = "beantagger.isCacheable" [static, private]

name of property that can be used to specify that a property or a bean is cacheable which neams that the property value or all properties values of the bean can be cached

Referenced by isCacheable(), and setCacheable().

final String cern::gp::beans::BeanTagger::IS_EXPANDABLE_PROPERTY_NAME = "beantagger.isExpandable" [static, private]

name of property that can be used to specify that a property is expandable which neams that the property value is a bean having more properties

Referenced by isExpandable(), and setExpandable().

---

The documentation for this class was generated from the following file:

• BeanTagger.java