cern.gp.beans

Class PropertyInfoSupport

java.lang.Object

cern.gp.beans.PropertyInfoSupport

All Implemented Interfaces:

PropertyInfo

public class PropertyInfoSupport
extends java.lang.Object
implements PropertyInfo

Support class allowing to create instances of PropertyInfo.

Author:

Lionel Mestre

See Also:

PropertyInfo, BeanDependentPropertyEditor

Constructor Summary

Constructors

Constructor and Description
PropertyInfoSupport(java.lang.String name, boolean isHidden) Creates a new PropertyInfoSupport with no PropertyEditorClass that is non cached, non expert and hidden or not depending of the given value.
PropertyInfoSupport(java.lang.String name, java.lang.Class propertyEditorClass) Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden.
PropertyInfoSupport(java.lang.String name, java.lang.String displayName) Creates a new PropertyInfoSupport with no PropertyEditor that is non cached, non expert and non hidden.
PropertyInfoSupport(java.lang.String name, java.lang.String displayName, java.lang.Class propertyEditorClass) Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Returns the display name of the property
java.lang.String	getName() Returns the name of the property
java.lang.Class	getPropertyEditorClass() Gets an explicit PropertyEditor Class for this property.
java.lang.Boolean	isCacheable() Returns a boolean indicating the caching strategy for this property.
boolean	isExpert() Returns if this property is expert.
boolean	isHidden() Returns if this property is hidden.
void	setIsCached(java.lang.Boolean isCached) Sets whether the property is cached or no.
void	setIsExpert(boolean isExpert) Sets whether the property is only visible to experts or no
void	setIsHidden(boolean isHidden) Sets whether the property is hidden or no
void	updatePropertyDescriptor(java.beans.PropertyDescriptor propertyDescriptor) Update the given PropertyDescriptor with the information contained in this PropertyInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyInfoSupport

public PropertyInfoSupport(java.lang.String name,
                           java.lang.Class propertyEditorClass)

Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden. The display name of the property will the name of the property.

Parameters:

name - the name of the property that PropertyInfo object is for

propertyEditorClass - the class of the property editor for this property

See Also:

BeanDependentPropertyEditor

PropertyInfoSupport

public PropertyInfoSupport(java.lang.String name,
                           java.lang.String displayName)

Creates a new PropertyInfoSupport with no PropertyEditor that is non cached, non expert and non hidden. The display name of the property will be the one specified.

Parameters:

name - the name of the property that PropertyInfo object is for

propertyEditorClass - the class of the property editor for this property

See Also:

BeanDependentPropertyEditor

PropertyInfoSupport

public PropertyInfoSupport(java.lang.String name,
                           java.lang.String displayName,
                           java.lang.Class propertyEditorClass)

Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden. The display name of the property will be the one specified.

Parameters:

name - the name of the property that PropertyInfo object is for

displayName - the display name of the property

propertyEditorClass - the class of the property editor for this property

See Also:

BeanDependentPropertyEditor

PropertyInfoSupport

public PropertyInfoSupport(java.lang.String name,
                           boolean isHidden)

Creates a new PropertyInfoSupport with no PropertyEditorClass that is non cached, non expert and hidden or not depending of the given value.

Parameters:

name - the name of the property that PropertyInfo object is for

isHidden - whether this property is hidden or not

Method Detail

setIsCached

public void setIsCached(java.lang.Boolean isCached)

Sets whether the property is cached or no. Null can be used to specify the default behavior.

Parameters:

isCached - whether the property is cached or no.

setIsExpert

public void setIsExpert(boolean isExpert)

Sets whether the property is only visible to experts or no

Parameters:

isExpert - whether the property is only visible to experts or no

setIsHidden

public void setIsHidden(boolean isHidden)

Sets whether the property is hidden or no

Parameters:

isHidden - whether the property is hidden or no

updatePropertyDescriptor

public void updatePropertyDescriptor(java.beans.PropertyDescriptor propertyDescriptor)

Description copied from interface: PropertyInfo

Update the given PropertyDescriptor with the information contained in this PropertyInfo

Specified by:

updatePropertyDescriptor in interface PropertyInfo

Parameters:

propertyDescriptor - the PropertyDescriptor to update

getName

public java.lang.String getName()

Description copied from interface: PropertyInfo

Returns the name of the property

Specified by:

getName in interface PropertyInfo

Returns:

the name of the property

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: PropertyInfo

Returns the display name of the property

Specified by:

getDisplayName in interface PropertyInfo

Returns:

the display name of the property

getPropertyEditorClass

public java.lang.Class getPropertyEditorClass()

Description copied from interface: PropertyInfo

Gets an explicit PropertyEditor Class for this property. The method will return "null" for indicating that no special editor has been registered, so the PropertyEditorManager should be used to locate a suitable PropertyEditor.

Specified by:

getPropertyEditorClass in interface PropertyInfo

Returns:

An explicit PropertyEditor Class for this property or null.

isCacheable

public java.lang.Boolean isCacheable()

Description copied from interface: PropertyInfo

Returns a boolean indicating the caching strategy for this property. Three value can be returned :

• null : no caching strategy specified, the property inherit from the one defined for the bean or from the default one if the bean does not specified one.
• True : the property can be cached. This will override the caching strategy defined at the bean level. It is the responsibility of the bean to send PropertyChangeEvent to update the cached value
• False : the property cannot be cached. This will override the caching strategy defined at the bean level.

Specified by:

isCacheable in interface PropertyInfo

Returns:

null, True or False depending the caching strategy specified.

isExpert

public boolean isExpert()

Description copied from interface: PropertyInfo

Returns if this property is expert. The "expert" flag is used to distinguish between those features that are intended for expert users from those that are intended for normal users.

Specified by:

isExpert in interface PropertyInfo

Returns:

true if this property is intended for use by experts only

isHidden

public boolean isHidden()

Description copied from interface: PropertyInfo

Returns if this property is hidden. The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.

Specified by:

isHidden in interface PropertyInfo

Returns:

true if this property should be hidden from human users.