com.xebialabs.deployit.reflect
Class ConfigurationItemPropertyDescriptor

java.lang.Object
  com.xebialabs.deployit.reflect.ConfigurationItemPropertyDescriptor

All Implemented Interfaces:

ConfigurationItemPropertyHolder, java.io.Serializable

public class ConfigurationItemPropertyDescriptor
extends java.lang.Object
implements java.io.Serializable, ConfigurationItemPropertyHolder

Describes a property of a ConfigurationItem.

See Also:

Serialized Form

Constructor Summary

ConfigurationItemPropertyDescriptor()
Deprecated. Needed for BlazeDS. Do not invoke!

ConfigurationItemPropertyDescriptor(ConfigurationItemDescriptor owningCIDescriptor, ConfigurationItemPropertyDescriptor owningPropertyDescriptor, java.lang.reflect.Field field, java.lang.String defaultValue, boolean isTopLevelClass)
Constructs a ConfigurationItemPropertyDescriptor.

Method Summary

java.lang.String	getCategory() Gets the category of this property.
java.lang.Class<?>	getCollectionMemberClass() Gets the collection member class, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS
java.lang.String	getCollectionMemberClassname() Gets the collection member class name, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS
static ConfigurationItemPropertyDescriptor[]	getConfigurationItemPropertyDescriptorsForListObject(ConfigurationItemDescriptor owningCIDescriptor, ConfigurationItemPropertyDescriptor owningPropertyDescriptor, java.lang.Class<?> listObjectClass) Constructs a list of ConfigurationItemPropertyDescriptors.
static ConfigurationItemPropertyDescriptor[]	getConfigurationItemPropertyDescriptorsForTopLevelClass(ConfigurationItemDescriptor owningCIDescriptor, java.lang.Class<?> typeClass, java.util.Map<java.lang.String,java.lang.String> configuredDefaults, java.lang.String defaultValueKeyPrefix) Constructs a list of ConfigurationItemPropertyDescriptors.
java.lang.String	getDefaultValue()
java.lang.String	getDescription() Gets the description of this property.
java.lang.String[]	getEnumValues() Gets the enum values, if this property is an ConfigurationItemPropertyType.ENUM
java.lang.String	getLabel() Gets the label of this property.
ConfigurationItemPropertyDescriptor[]	getListObjectPropertyDescriptors() Gets the property descriptors of the collection member classes, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS
java.lang.String	getName() Gets the name of this property.
ConfigurationItemDescriptor	getOwningConfigurationItemDescriptor() Gets the descriptor of the configuration item that has this property.
ConfigurationItemPropertyDescriptor	getOwningPropertyDescriptor() Gets the descriptor of the property that has this property.
java.lang.Class<?>	getPropertyClass() Gets the class of this property.
java.lang.String	getPropertyClassname() Gets the class name of this property
ConfigurationItemPropertyDescriptor	getPropertyDescriptor(java.lang.String propertyName) Gets the property descriptor for a named property of the collection member class, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS
ConfigurationItemPropertyDescriptor[]	getPropertyDescriptors()
java.lang.reflect.Field	getPropertyField() Gets the Field for this property.
java.lang.Object	getPropertyValueFromConfigurationItem(java.lang.Object configurationItem) Gets a property from a configuration item.
ConfigurationItemProperty.Size	getSize() Gets the display size of this property.
ConfigurationItemPropertyType	getType() Gets the type of this property.
boolean	isEditable() Return whether this property is a editable.
boolean	isIdentifying() Return whether this property is an identifying property.
boolean	isPassword() Return whether this property is a password.
boolean	isRequired() Return whether this property is required.
void	setCategory(java.lang.String grouping) Deprecated. Needed for BlazeDS. Do not invoke!
void	setCollectionMemberClassname(java.lang.String collectionMemberClassname) Deprecated. Needed for BlazeDS. Do not invoke!
void	setDefaultValue(java.lang.String defaultValue) Deprecated. Needed for BlazeDS. Do not invoke!
void	setDescription(java.lang.String description) Deprecated. Needed for BlazeDS. Do not invoke!
void	setEditable(boolean editable) Deprecated. Needed for BlazeDS. Do not invoke!
void	setEnumValues(java.lang.String[] enumValues) Deprecated. Needed for BlazeDS. Do not invoke!
void	setIdentifying(boolean identifying) Deprecated. Needed for BlazeDS. Do not invoke!
void	setLabel(java.lang.String label) Deprecated. Needed for BlazeDS. Do not invoke!
void	setListObjectPropertyDescriptors(ConfigurationItemPropertyDescriptor[] listObjectPropertyDescriptors) Deprecated. Needed for BlazeDS. Do not invoke!
void	setName(java.lang.String name) Deprecated. Needed for BlazeDS. Do not invoke!
void	setOwningConfigurationItemDescriptor(ConfigurationItemDescriptor configurationItemDescriptor) Deprecated. Needed for BlazeDS. Do not invoke!
void	setOwningPropertyDescriptor(ConfigurationItemPropertyDescriptor owningPropertyDescriptor) Deprecated. Needed for BlazeDS. Do not invoke!
void	setPassword(boolean password) Deprecated. Needed for BlazeDS. Do not invoke!
void	setPropertyClassname(java.lang.String propertyClassname) Deprecated. Needed for BlazeDS. Do not invoke!
void	setPropertyValueInConfigurationItem(java.lang.Object configurationItem, java.lang.Object value) Sets a property value on a configuration item.
void	setRequired(boolean required) Deprecated. Needed for BlazeDS. Do not invoke!
void	setSize(ConfigurationItemProperty.Size size) Deprecated. Needed for BlazeDS. Do not invoke!
void	setType(ConfigurationItemPropertyType type) Deprecated. Needed for BlazeDS. Do not invoke!
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationItemPropertyDescriptor

public ConfigurationItemPropertyDescriptor()

Deprecated. Needed for BlazeDS. Do not invoke!

ConfigurationItemPropertyDescriptor

public ConfigurationItemPropertyDescriptor(ConfigurationItemDescriptor owningCIDescriptor,
                                           ConfigurationItemPropertyDescriptor owningPropertyDescriptor,
                                           java.lang.reflect.Field field,
                                           java.lang.String defaultValue,
                                           boolean isTopLevelClass)

Constructs a ConfigurationItemPropertyDescriptor. Do not invoke!

Method Detail

getConfigurationItemPropertyDescriptorsForListObject

public static ConfigurationItemPropertyDescriptor[] getConfigurationItemPropertyDescriptorsForListObject(ConfigurationItemDescriptor owningCIDescriptor,
                                                                                                         ConfigurationItemPropertyDescriptor owningPropertyDescriptor,
                                                                                                         java.lang.Class<?> listObjectClass)

Constructs a list of ConfigurationItemPropertyDescriptors. Do not invoke!

getConfigurationItemPropertyDescriptorsForTopLevelClass

public static ConfigurationItemPropertyDescriptor[] getConfigurationItemPropertyDescriptorsForTopLevelClass(ConfigurationItemDescriptor owningCIDescriptor,
                                                                                                            java.lang.Class<?> typeClass,
                                                                                                            java.util.Map<java.lang.String,java.lang.String> configuredDefaults,
                                                                                                            java.lang.String defaultValueKeyPrefix)

Constructs a list of ConfigurationItemPropertyDescriptors. Do not invoke!

getPropertyValueFromConfigurationItem

public java.lang.Object getPropertyValueFromConfigurationItem(java.lang.Object configurationItem)

Gets a property from a configuration item.

Parameters:

configurationItem - the configuration item to get the property value from.

Returns:

the property value on the configuration item.

setPropertyValueInConfigurationItem

public void setPropertyValueInConfigurationItem(java.lang.Object configurationItem,
                                                java.lang.Object value)

Sets a property value on a configuration item.

Parameters:

configurationItem - the configuration item to set the value on.

value - the value to set

getOwningConfigurationItemDescriptor

public ConfigurationItemDescriptor getOwningConfigurationItemDescriptor()

Gets the descriptor of the configuration item that has this property.

Returns:

the descriptor of the configuration item that has this property.

setOwningConfigurationItemDescriptor

public void setOwningConfigurationItemDescriptor(ConfigurationItemDescriptor configurationItemDescriptor)

Deprecated. Needed for BlazeDS. Do not invoke!

getOwningPropertyDescriptor

public ConfigurationItemPropertyDescriptor getOwningPropertyDescriptor()

Gets the descriptor of the property that has this property.

Returns:

the descriptor of the property that has this property.

setOwningPropertyDescriptor

public void setOwningPropertyDescriptor(ConfigurationItemPropertyDescriptor owningPropertyDescriptor)

Deprecated. Needed for BlazeDS. Do not invoke!

getName

public java.lang.String getName()

Gets the name of this property.

Returns:

the name of this property.

setName

public void setName(java.lang.String name)

Deprecated. Needed for BlazeDS. Do not invoke!

getPropertyField

public java.lang.reflect.Field getPropertyField()

Gets the Field for this property.

Returns:

the field for this property.

getType

public ConfigurationItemPropertyType getType()

Gets the type of this property.

Returns:

the type of this property.

setType

public void setType(ConfigurationItemPropertyType type)

Deprecated. Needed for BlazeDS. Do not invoke!

getPropertyClassname

public java.lang.String getPropertyClassname()

Gets the class name of this property

Returns:

the class name of this property

setPropertyClassname

public void setPropertyClassname(java.lang.String propertyClassname)

Deprecated. Needed for BlazeDS. Do not invoke!

getPropertyClass

public java.lang.Class<?> getPropertyClass()

Gets the class of this property.

Returns:

the class of this property.

getEnumValues

public java.lang.String[] getEnumValues()

Gets the enum values, if this property is an ConfigurationItemPropertyType.ENUM

Returns:

the enum values or null if this property is not an ConfigurationItemPropertyType.ENUM,

setEnumValues

public void setEnumValues(java.lang.String[] enumValues)

Deprecated. Needed for BlazeDS. Do not invoke!

getCollectionMemberClassname

public java.lang.String getCollectionMemberClassname()

Gets the collection member class name, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS

Returns:

the collection member class name or null if this property is not an ConfigurationItemPropertyType.LIST_OF_OBJECTS,

setCollectionMemberClassname

public void setCollectionMemberClassname(java.lang.String collectionMemberClassname)

Deprecated. Needed for BlazeDS. Do not invoke!

getCollectionMemberClass

public java.lang.Class<?> getCollectionMemberClass()

Gets the collection member class, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS

Returns:

the collection member class or null if this property is not an ConfigurationItemPropertyType.LIST_OF_OBJECTS.

getListObjectPropertyDescriptors

public ConfigurationItemPropertyDescriptor[] getListObjectPropertyDescriptors()

Gets the property descriptors of the collection member classes, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS

Returns:

the property descriptors of the collection member classes or null if this property is not an ConfigurationItemPropertyType.LIST_OF_OBJECTS.

getPropertyDescriptors

public ConfigurationItemPropertyDescriptor[] getPropertyDescriptors()

Specified by:

getPropertyDescriptors in interface ConfigurationItemPropertyHolder

See Also:

getListObjectPropertyDescriptors().

getPropertyDescriptor

public ConfigurationItemPropertyDescriptor getPropertyDescriptor(java.lang.String propertyName)

Gets the property descriptor for a named property of the collection member class, if this property is an ConfigurationItemPropertyType.LIST_OF_OBJECTS

Specified by:

getPropertyDescriptor in interface ConfigurationItemPropertyHolder

Parameters:

propertyName - the name of the property sought after.

Returns:

the property descriptor for a named property of the collection member class or null if this property is not an ConfigurationItemPropertyType.LIST_OF_OBJECTS.

setListObjectPropertyDescriptors

public void setListObjectPropertyDescriptors(ConfigurationItemPropertyDescriptor[] listObjectPropertyDescriptors)

Deprecated. Needed for BlazeDS. Do not invoke!

getLabel

public java.lang.String getLabel()

Gets the label of this property.

Returns:

the label of this property.

setLabel

public void setLabel(java.lang.String label)

Deprecated. Needed for BlazeDS. Do not invoke!

getDescription

public java.lang.String getDescription()

Gets the description of this property.

Returns:

the description of this property.

setDescription

public void setDescription(java.lang.String description)

Deprecated. Needed for BlazeDS. Do not invoke!

isRequired

public boolean isRequired()

Return whether this property is required.

Returns:

true iff this property is required.

setRequired

public void setRequired(boolean required)

Deprecated. Needed for BlazeDS. Do not invoke!

isPassword

public boolean isPassword()

Return whether this property is a password.

Returns:

true iff this property is a password.

setPassword

public void setPassword(boolean password)

Deprecated. Needed for BlazeDS. Do not invoke!

isEditable

public boolean isEditable()

Return whether this property is a editable.

Returns:

true iff this property is a editable.

setEditable

public void setEditable(boolean editable)

Deprecated. Needed for BlazeDS. Do not invoke!

isIdentifying

public boolean isIdentifying()

Return whether this property is an identifying property.

Returns:

true iff this property is an identifying property.

setIdentifying

public void setIdentifying(boolean identifying)

Deprecated. Needed for BlazeDS. Do not invoke!

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Deprecated. Needed for BlazeDS. Do not invoke!

getCategory

public java.lang.String getCategory()

Gets the category of this property.

Returns:

the category of this property.

setCategory

public void setCategory(java.lang.String grouping)

Deprecated. Needed for BlazeDS. Do not invoke!

getSize

public ConfigurationItemProperty.Size getSize()

Gets the display size of this property.

Returns:

the display size of this property.

setSize

public void setSize(ConfigurationItemProperty.Size size)

Deprecated. Needed for BlazeDS. Do not invoke!

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object