Package org.opt4j.core.config

Class Property

java.lang.Object

org.opt4j.core.config.Property

public class Property
extends Object

The Property contains information about a single property of a PropertyModule.

Constructor Summary

Constructors

Constructor	Description
Property(Module module, String name, Class<?> type, Method getter, Method setter, Iterable<Annotation> annotations)	Constructs a Property .

Method Summary

Modifier and Type	Method	Description
void	addRequirement(Requirement requirement)	Adds a Requirement.
<A extends Annotation> A	getAnnotation(Class<? extends A> clazz)	Returns the annotation of the specified class or null if not existent.
Collection<Annotation>	getAnnotations()	Returns the annotations of this property.
Method	getGetter()	Returns the getter method.
String	getInfo()	Returns the info.
String	getName()	Returns the name.
int	getOrder()	Returns the order.
Collection<Requirement>	getRequirements()	Returns the requirements.
Method	getSetter()	Returns the setter method.
Class<?>	getType()	Returns the type.
Object	getValue()	Returns the value of the property.
boolean	isActive()	Returns true if the property is active, i.e., all Requirements must be fulfilled.
boolean	isNumber()	Returns true if the property represents a number.
void	setInfo(String info)	Sets the info.
void	setOrder(int order)	Sets the order.
void	setValue(Object value)	Sets the value of the property.
void	setValue(String value)	Sets the value of the property.

Methods inherited from class java.lang.Object

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

Constructor Details

Property

public Property(Module module,
 String name,
 Class<?> type,
 Method getter,
 Method setter,
 Iterable<Annotation> annotations)

Constructs a Property .

Parameters:

module - the module

name - the name

type - the type

getter - the getter method

setter - the setter method

annotations - the annotations

Method Details

getInfo

public String getInfo()

Returns the info.

Returns:

the info

See Also:

• setInfo(java.lang.String)

setInfo

public void setInfo(String info)

Sets the info.

Parameters:

info - the info to set

See Also:

• getInfo()

getOrder

public int getOrder()

Returns the order.

Returns:

the order

See Also:

• setOrder(int)

setOrder

public void setOrder(int order)

Sets the order.

Parameters:

order - the order to set

See Also:

• getOrder()

getName

public String getName()

Returns the name.

Returns:

the name

getType

public Class<?> getType()

Returns the type.

Returns:

the type

getGetter

public Method getGetter()

Returns the getter method.

Returns:

the getter

getSetter

public Method getSetter()

Returns the setter method.

Returns:

the setter

addRequirement

public void addRequirement(Requirement requirement)

Adds a Requirement.

Parameters:

requirement - the requirement to add

isActive

public boolean isActive()

Returns true if the property is active, i.e., all Requirements must be fulfilled.

Returns:

true if the property is active

getRequirements

public Collection<Requirement> getRequirements()

Returns the requirements.

Returns:

the requirements

getValue

public Object getValue()

Returns the value of the property.

Returns:

the value of the property

See Also:

• setValue(java.lang.Object)

setValue

public void setValue(Object value)
              throws InvocationTargetException

Sets the value of the property.

Parameters:

value - the value to set

Throws:

InvocationTargetException - thrown if the value cannot be assigned

See Also:

• getValue()

setValue

public void setValue(String value)
              throws InvocationTargetException

Sets the value of the property. The property has first to be converted to the corresponding type.

Parameters:

value - the value to set

Throws:

InvocationTargetException - thrown if the value cannot be assigned

isNumber

public boolean isNumber()

Returns true if the property represents a number.

Returns:

true if the property represents a number

getAnnotations

public Collection<Annotation> getAnnotations()

Returns the annotations of this property.

Returns:

the annotations

getAnnotation

public <A extends Annotation> A getAnnotation(Class<? extends A> clazz)

Returns the annotation of the specified class or null if not existent.

Type Parameters:

A - the annotation type

Parameters:

clazz - the specific annotation class

Returns:

the annotation