Package net.infonode.properties.base
Interface Property
-
- All Known Implementing Classes:
AbstractProperty
,AlignmentProperty
,BooleanProperty
,BorderProperty
,ButtonFactoryProperty
,ColorProperty
,ComponentPainterProperty
,DimensionProviderProperty
,DirectionProperty
,DockingWindowActionProperty
,DockingWindowTitleProviderProperty
,DropFilterProperty
,EnumProperty
,FloatProperty
,FontProperty
,HoverListenerProperty
,IconProperty
,InsetsProperty
,IntegerProperty
,NumberProperty
,PropertyGroupProperty
,PropertyMapProperty
,StringProperty
,TabAreaVisiblePolicyProperty
,TabbedPanelHoverPolicyProperty
,TabDepthOrderPolicyProperty
,TabDropDownListVisiblePolicyProperty
,TabLayoutPolicyProperty
,TabSelectTriggerProperty
,TitledTabBorderSizePolicyProperty
,TitledTabSizePolicyProperty
,ValueHandlerProperty
public interface Property
A property is belongs to aPropertyGroup
and contains name, description, type etc. A property can have multiple values which can be stored in any type of object.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
getName
java.lang.String getName()
Returns the property name.- Returns:
- the property name
-
getDescription
java.lang.String getDescription()
Returns a description of this property.- Returns:
- a description of this property
-
getType
java.lang.Class getType()
Returns the value type of this property. The property can only be set to values that are of this class or a sub class of this class.- Returns:
- the value type of this property
-
getGroup
PropertyGroup getGroup()
Returns the property group that this property belongs to.- Returns:
- the property group that this property belongs to
-
getValue
java.lang.Object getValue(java.lang.Object valueContainer) throws InvalidPropertyException
Returns the value of this property in a value container.- Parameters:
valueContainer
- the object containing the value- Returns:
- the value of this property in an valueContainer, null if the container doesn't contain the value
- Throws:
InvalidPropertyException
- if the property can not be read from the value container
-
setValue
void setValue(java.lang.Object valueContainer, java.lang.Object value) throws ImmutablePropertyException, InvalidPropertyException, InvalidPropertyValueException
Sets the value of this property in an object.- Parameters:
valueContainer
- the object to set the property value invalue
- the value of the property- Throws:
ImmutablePropertyException
- if this property is immutableInvalidPropertyException
- if this property can't be set in the objectInvalidPropertyValueException
- if the property value is invalid
-
canBeAssiged
boolean canBeAssiged(java.lang.Object value)
Returns true if the value can be assigned to this property.- Parameters:
value
- the value to assign- Returns:
- true if the value can be assigned to this property
-
isMutable
boolean isMutable()
Returns true if this property is mutable.- Returns:
- true if this property is mutable
-
valueIsRemovable
boolean valueIsRemovable(java.lang.Object valueContainer)
Returns true if the value of this property can be removed from the valueContainer.- Parameters:
valueContainer
- the object from which to remove the value- Returns:
- true if the value of this property can be removed from the valueContainer
-
valueIsSet
boolean valueIsSet(java.lang.Object valueContainer)
Returns true if this property has a value in the valueContainer.- Parameters:
valueContainer
- the object that might contain the value- Returns:
- true if this property has a value in the valueContainer
-
removeValue
void removeValue(java.lang.Object valueContainer) throws ImmutablePropertyException, CantRemoveValueException
Removes the value of this property from an valueContainer.- Parameters:
valueContainer
- the object in which to remove the value- Throws:
ImmutablePropertyException
- if the property is immutableCantRemoveValueException
- if the property value can't be removed from the valueContainer
-
-