com.vaadin.data.util

Class GeneratedPropertyContainer.GeneratedProperty<T>

java.lang.Object

com.vaadin.data.util.GeneratedPropertyContainer.GeneratedProperty<T>

All Implemented Interfaces:

Property<T>, Serializable

Enclosing class:

GeneratedPropertyContainer

protected static class GeneratedPropertyContainer.GeneratedProperty<T>
extends Object
implements Property<T>

Property implementation for generated properties

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.Property

Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeEvent, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeEvent, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Constructor Summary

Constructors

Constructor and Description
GeneratedProperty(Item item, Object propertyId, Object itemId, PropertyValueGenerator<T> generator)

Method Summary

Modifier and Type	Method and Description
Class<? extends T>	getType() Returns the type of the Property.
T	getValue() Gets the value stored in the Property.
boolean	isReadOnly() Tests if the Property is in read-only mode.
void	setReadOnly(boolean newStatus) Sets the Property's read-only mode to the specified status.
void	setValue(T newValue) 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

GeneratedProperty

public GeneratedProperty(Item item,
                         Object propertyId,
                         Object itemId,
                         PropertyValueGenerator<T> generator)

Method Detail

getValue

public T getValue()

Description copied from interface: Property

Gets the value stored in the Property. The returned object is compatible with the class returned by getType().

Specified by:

getValue in interface Property<T>

Returns:

the value stored in the Property

setValue

public void setValue(T newValue)
              throws Property.ReadOnlyException

Description copied from interface: Property

Sets the value of the Property.

Implementing this functionality is optional. If the functionality is missing, one should declare the Property to be in read-only mode and throw Property.ReadOnlyException in this function.

Note : Since Vaadin 7.0, setting the value of a non-String property as a String is no longer supported.

Specified by:

setValue in interface Property<T>

Parameters:

newValue - New value of the Property. This should be assignable to the type returned by getType

Throws:

Property.ReadOnlyException - if the object is in read-only mode

getType

public Class<? extends T> getType()

Description copied from interface: Property

Returns the type of the Property. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property<T>

Returns:

type of the Property

isReadOnly

public boolean isReadOnly()

Description copied from interface: Property

Tests if the Property is in read-only mode. In read-only mode calls to the method setValue will throw ReadOnlyException and will not modify the value of the Property.

Specified by:

isReadOnly in interface Property<T>

Returns:

true if the Property is in read-only mode, false if it's not

setReadOnly

public void setReadOnly(boolean newStatus)

Description copied from interface: Property

Sets the Property's read-only mode to the specified status. This functionality is optional, but all properties must implement the isReadOnly mode query correctly.

Specified by:

setReadOnly in interface Property<T>

Parameters:

newStatus - new read-only status of the Property