PropertyInfo (CWF Shell 6.0.0-RC3 API)

java.lang.Object
- org.carewebframework.shell.property.PropertyInfo

```
public class PropertyInfo
extends Object
```
Holds information about a specific plug-in property.

Constructor Summary

Constructors
Constructor and Description

PropertyInfo()

Constructors
Constructor and Description
`PropertyInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Properties`	`getConfig()`
`String`	`getConfigValue(String key)` This is a convenience method for returning a named configuration value.
`String[]`	`getConfigValueArray(String key)` This is a convenience method for returning a named configuration value that is expected to be a list of array elements delimited by commas.
`String[]`	`getConfigValueArray(String key, String delimiter)` This is a convenience method for returning a named configuration value that is expected to be a list of array elements.
`Boolean`	`getConfigValueBoolean(String key, Boolean dflt)` This is a convenience method for returning a named configuration value that is expected to be a Boolean value.
`Double`	`getConfigValueDouble(String key, Double dflt)` This is a convenience method for returning a named configuration value that is expected to be a double floating point number.
`Integer`	`getConfigValueInt(String key, Integer dflt)` This is a convenience method for returning a named configuration value that is expected to be an integer.
`String`	`getDefault()` Returns the default value for this property.
`String`	`getDescription()`
`String`	`getGetter()`
`String`	`getId()`
`String`	`getName()`
`PropertyType`	`getPropertyType()`
`Object`	`getPropertyValue(Object instance)` Returns the property value for a specified object instance.
`Object`	`getPropertyValue(Object instance, boolean forceDirect)` Returns the property value for a specified object instance.
`String`	`getSetter()`
`String`	`getType()`
`boolean`	`isEditable()` Returns whether the property's value is editable.
`boolean`	`isSerializable()` Returns whether the property is serializable.
`void`	`setConfig(Properties config)`
`void`	`setConfig(String config)`
`void`	`setDefault(String dflt)` Sets the default value for this property.
`void`	`setDescription(String description)`
`void`	`setEditable(boolean editable)` Sets whether the object is editable.
`void`	`setGetter(String getter)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setPropertyValue(Object instance, Object value)` Sets the property value for a specified object instance.
`void`	`setPropertyValue(Object instance, Object value, boolean forceDirect)` Sets the property value for a specified object instance.
`void`	`setSerializable(boolean serializable)` Sets whether the object is serializable.
`void`	`setSetter(String setter)`
`void`	`setType(String type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropertyInfo
```
public PropertyInfo()
```
- Method Detail
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getId
```
public String getId()
```
  - setId
```
public void setId(String id)
```
  - getGetter
```
public String getGetter()
```
  - setGetter
```
public void setGetter(String getter)
```
  - getSetter
```
public String getSetter()
```
  - setSetter
```
public void setSetter(String setter)
```
  - getPropertyType
```
public PropertyType getPropertyType()
```
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - getConfig
```
public Properties getConfig()
```
  - setConfig
```
public void setConfig(String config)
```
  - setConfig
```
public void setConfig(Properties config)
```
  - getPropertyValue
```
public Object getPropertyValue(Object instance)
```
    Returns the property value for a specified object instance.
    
    Parameters:
    
    instance - The object instance.
    
    Returns:
    
    The object's property value.
  - getPropertyValue
```
public Object getPropertyValue(Object instance,
                               boolean forceDirect)
```
    Returns the property value for a specified object instance.
    
    Parameters:
    
    instance - The object instance.
    
    forceDirect - If true, a forces a direct read on the instance even if it implements IPropertyAccessor
    
    Returns:
    
    The object's property value.
  - setPropertyValue
```
public void setPropertyValue(Object instance,
                             Object value)
```
    Sets the property value for a specified object instance.
    
    Parameters:
    
    instance - The object instance.
    
    value - The value to assign.
  - setPropertyValue
```
public void setPropertyValue(Object instance,
                             Object value,
                             boolean forceDirect)
```
    Sets the property value for a specified object instance.
    
    Parameters:
    
    instance - The object instance.
    
    value - The value to assign.
    
    forceDirect - If true, a forces a direct write to the instance even if it implements IPropertyAccessor
  - isSerializable
```
public boolean isSerializable()
```
    Returns whether the property is serializable.
    
    Returns:
    
    True if the property is serializable.
  - setSerializable
```
public void setSerializable(boolean serializable)
```
    Sets whether the object is serializable. Properties marked as not serializable will be ignored during the serialization/deserialization process.
    
    Parameters:
    
    serializable - True if the property is serializable.
  - isEditable
```
public boolean isEditable()
```
    Returns whether the property's value is editable.
    
    Returns:
    
    True if the property is editable.
  - setEditable
```
public void setEditable(boolean editable)
```
    Sets whether the object is editable. Properties marked as not editable will be not be presented by the property editor.
    
    Parameters:
    
    editable - True if the property is editable.
  - getConfigValue
```
public String getConfigValue(String key)
```
    This is a convenience method for returning a named configuration value.
    
    Parameters:
    
    key - The configuration value's key.
    
    Returns:
    
    Configuration value or null if not found.
  - getConfigValueInt
```
public Integer getConfigValueInt(String key,
                                 Integer dflt)
```
    This is a convenience method for returning a named configuration value that is expected to be an integer.
    
    Parameters:
    
    key - The configuration value's key.
    
    dflt - Default value.
    
    Returns:
    
    Configuration value as an integer or default value if not found or not a valid integer.
  - getConfigValueDouble
```
public Double getConfigValueDouble(String key,
                                   Double dflt)
```
    This is a convenience method for returning a named configuration value that is expected to be a double floating point number.
    
    Parameters:
    
    key - The configuration value's key.
    
    dflt - Default value.
    
    Returns:
    
    Configuration value as a double or default value if not found or not a valid double.
  - getConfigValueBoolean
```
public Boolean getConfigValueBoolean(String key,
                                     Boolean dflt)
```
    This is a convenience method for returning a named configuration value that is expected to be a Boolean value.
    
    Parameters:
    
    key - The configuration value's key.
    
    dflt - Default value.
    
    Returns:
    
    Configuration value as a Boolean or default value if not found or not a valid Boolean.
  - getConfigValueArray
```
public String[] getConfigValueArray(String key)
```
    This is a convenience method for returning a named configuration value that is expected to be a list of array elements delimited by commas.
    
    Parameters:
    
    key - The configuration value's key.
    
    Returns:
    
    The array of values.
  - getConfigValueArray
```
public String[] getConfigValueArray(String key,
                                    String delimiter)
```
    This is a convenience method for returning a named configuration value that is expected to be a list of array elements.
    
    Parameters:
    
    key - The configuration value's key.
    
    delimiter - The delimiter separating array elements.
    
    Returns:
    
    The array of values.
  - getDefault
```
public String getDefault()
```
    Returns the default value for this property.
    
    Returns:
    
    The default value.
  - setDefault
```
public void setDefault(String dflt)
```
    Sets the default value for this property.
    
    Parameters:
    
    dflt - The default value.

Class PropertyInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertyInfo

Method Detail

getName

setName

getId

setId

getGetter

setGetter

getSetter

setSetter

getPropertyType

getType

setType

getDescription

setDescription

getConfig

setConfig

setConfig

getPropertyValue

getPropertyValue

setPropertyValue

setPropertyValue

isSerializable

setSerializable

isEditable

setEditable

getConfigValue

getConfigValueInt

getConfigValueDouble

getConfigValueBoolean

getConfigValueArray

getConfigValueArray

getDefault

setDefault