org.molgenis.util

Class Property<GaType>

java.lang.Object

java.util.Observable

org.molgenis.util.Property<GaType>

public class Property<GaType>
extends Observable

Implementation of a property. This class is a generic, which can be used for adding properties to your class. It has the get and set methods, so there is no need to specify them for each property, resulting in cleaner code. Furthermore the class has some extended functionality with which the access to the value of the property can be regulated and the class extends the Observable class, so other classes cam listen in on a change of the value.

A property should be used in the following manner:

    class Example
    {
       public final Property<int> property = new Property<int>(0, true);
    }
    
    Example example = new Example();
    try
    {
       example.property.set(1);
    }
    catch (IllegalAccessException e)
    {
       System.out.println(e.getMessage());
    }
 

Constructor Summary

Constructors

Constructor and Description
Property(GaType value) Default constructor which sets the property-value to the given value and the editable-flag to true.
Property(GaType value, boolean editable) Default constructor which sets the property-value to the given value and the editable-flag to given value.

Method Summary

Modifier and Type	Method and Description
GaType	get() Returns the value of the property.
boolean	isEditable() Returns true when the set-method of this property can be called and false otherwise.
void	set(GaType value) Sets the given value as the new value for the property.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(GaType value)

Default constructor which sets the property-value to the given value and the editable-flag to true.

Parameters:

value - The value for the property.

Property

public Property(GaType value,
                boolean editable)

Default constructor which sets the property-value to the given value and the editable-flag to given value.

Parameters:

value - The value for the property.

editable - The editable-flag.

Method Detail

set

public void set(GaType value)
         throws IllegalAccessException

Sets the given value as the new value for the property. When the editable-flag is set to false, this method throws an exception. Otherwise the value is changed and all the registered observers are notied of the change.

Parameters:

value - The new value for the property

Throws:

IllegalAccessException - Thrown when the editable-flag has been set to false.

get

public GaType get()

Returns the value of the property.

Returns:

The value of the property.

isEditable

public boolean isEditable()

Returns true when the set-method of this property can be called and false otherwise.

Returns:

True when the property can be set.