org.youscope.addon.component.generic

Class Property

java.lang.Object

org.youscope.addon.component.generic.Property

public class Property
extends java.lang.Object

Class representing a property in the configuration.

Author:

Moritz Lang

Constructor Summary

Constructors

Constructor and Description
Property(java.lang.Class<? extends Configuration> configurationClass, java.lang.String propertyID) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.reflect.Method	getGetter() Returns the getter method for this property.
java.lang.String	getName() Returns the (human readable) name of the property.
java.lang.reflect.Method	getSetter() Returns the setter method for this property.
java.lang.Class<?>	getType() Returns the property type.
java.lang.Object	getValue(Configuration configuration) Returns the value of the property.
<T> T	getValue(Configuration configuration, java.lang.Class<T> valueType) Returns the value of this property, cased to a specific class.
boolean	isConditionalFulfilled(Configuration configuration) Checks if conditional function for property to make sense to add to UI is fulfilled.
boolean	isVisible() Returns true if property should be shown in configuration.
void	setValue(Configuration configuration, java.lang.Object value) Sets the value of the property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(java.lang.Class<? extends Configuration> configurationClass,
                java.lang.String propertyID)
         throws GenericException

Constructor.

Parameters:

configurationClass - The class of the configuration of which this is a property.

propertyID - The ID/name of the property.

Throws:

GenericException

Method Detail

isVisible

public boolean isVisible()

Returns true if property should be shown in configuration.

Returns:

True if property should be shown.

getGetter

public java.lang.reflect.Method getGetter()

Returns the getter method for this property.

Returns:

Getter method

getSetter

public java.lang.reflect.Method getSetter()

Returns the setter method for this property.

Returns:

setter method.

getName

public java.lang.String getName()

Returns the (human readable) name of the property.

Returns:

name of property.

getType

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

Returns the property type.

Returns:

Property type.

getValue

public java.lang.Object getValue(Configuration configuration)
                          throws GenericException

Returns the value of the property. The returned object is of type getType()

Parameters:

configuration - The configuration for which the value of the property should be returned.

Returns:

Value of property.

Throws:

GenericException

isConditionalFulfilled

public boolean isConditionalFulfilled(Configuration configuration)
                               throws GenericException

Checks if conditional function for property to make sense to add to UI is fulfilled. If no conditional function is defined, returns null.

Parameters:

configuration - The configuration for which the value of the property should be returned.

Returns:

True if condition is fulfilled or not defined, false otherwise.

Throws:

GenericException

getValue

public <T> T getValue(Configuration configuration,
                      java.lang.Class<T> valueType)
               throws GenericException

Returns the value of this property, cased to a specific class.

Parameters:

configuration - The configuration for which the value of the property should be returned.

valueType - class of property.

Returns:

Value of property.

Throws:

GenericException

setValue

public void setValue(Configuration configuration,
                     java.lang.Object value)
              throws GenericException

Sets the value of the property.

Parameters:

configuration - Configuration in which the value should be set.

value - Value which should be set. Should have the correct type.

Throws:

GenericException