public interface Property
PropertyGroup
and contains name, description, type etc.
A property can have multiple values which can be stored in any type of object.Modifier and Type | Method and Description |
---|---|
boolean |
canBeAssiged(java.lang.Object value)
Returns true if the value can be assigned to this property.
|
java.lang.String |
getDescription()
Returns a description of this property.
|
PropertyGroup |
getGroup()
Returns the property group that this property belongs to.
|
java.lang.String |
getName()
Returns the property name.
|
java.lang.Class |
getType()
Returns the value type of this property.
|
java.lang.Object |
getValue(java.lang.Object valueContainer)
Returns the value of this property in a value container.
|
boolean |
isMutable()
Returns true if this property is mutable.
|
void |
removeValue(java.lang.Object valueContainer)
Removes the value of this property from an valueContainer.
|
void |
setValue(java.lang.Object valueContainer,
java.lang.Object value)
Sets the value of this property in an object.
|
boolean |
valueIsRemovable(java.lang.Object valueContainer)
Returns true if the value of this property can be removed from the valueContainer.
|
boolean |
valueIsSet(java.lang.Object valueContainer)
Returns true if this property has a value in the valueContainer.
|
java.lang.String getName()
java.lang.String getDescription()
java.lang.Class getType()
PropertyGroup getGroup()
java.lang.Object getValue(java.lang.Object valueContainer) throws InvalidPropertyException
valueContainer
- the object containing the valueInvalidPropertyException
- if the property can not be read from the value containervoid setValue(java.lang.Object valueContainer, java.lang.Object value) throws ImmutablePropertyException, InvalidPropertyException, InvalidPropertyValueException
valueContainer
- the object to set the property value invalue
- the value of the propertyImmutablePropertyException
- if this property is immutableInvalidPropertyException
- if this property can't be set in the objectInvalidPropertyValueException
- if the property value is invalidboolean canBeAssiged(java.lang.Object value)
value
- the value to assignboolean isMutable()
boolean valueIsRemovable(java.lang.Object valueContainer)
valueContainer
- the object from which to remove the valueboolean valueIsSet(java.lang.Object valueContainer)
valueContainer
- the object that might contain the valuevoid removeValue(java.lang.Object valueContainer) throws ImmutablePropertyException, CantRemoveValueException
valueContainer
- the object in which to remove the valueImmutablePropertyException
- if the property is immutableCantRemoveValueException
- if the property value can't be removed from the valueContainer