ch.tatool.data

Interface Property<T>

public interface Property<T>

A Property is a read-write object of values from/to elements and from/to DataContainers.

Author:

Michael Ruflin

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue(DataContainer dataContainer, PropertyHolder holder)
void	clearValue(DataContainer dataContainer, String id)
void	clearValue(PropertyHolder holder)
String	getPropertyName()
Class<?>	getPropertyType()
String	getStringValue(DataContainer dataContainer, PropertyHolder holder)
String	getStringValue(DataContainer dataContainer, PropertyHolder holder, String defaultValue)
String	getStringValue(DataContainer dataContainer, String id)
String	getStringValue(DataContainer dataContainer, String id, String defaultValue)
T	getValue(DataContainer dataContainer, PropertyHolder holder) Get a value stored in a DataContainer.
T	getValue(DataContainer dataContainer, PropertyHolder holder, T defaultValue)
T	getValue(DataContainer dataContainer, String id)
T	getValue(DataContainer dataContainer, String id, T defaultValue)
T	getValue(PropertyHolder holder)
T	getValue(PropertyHolder holder, T defaultValue)
void	restoreValue(DataContainer dataContainer, PropertyHolder holder) Restores a value from a DataContainer back into the element.
void	restoreValue(DataContainer dataContainer, PropertyHolder holder, T defaultValue)
void	setStringValue(DataContainer dataContainer, PropertyHolder holder, String value)
void	setStringValue(DataContainer dataContainer, String id, String value)
void	setValue(DataContainer dataContainer, PropertyHolder holder)
void	setValue(DataContainer dataContainer, PropertyHolder holder, T value)
void	setValue(DataContainer dataContainer, String id, T value)
void	setValue(PropertyHolder holder, T value)

Method Detail

getPropertyName

String getPropertyName()

getPropertyType

Class<?> getPropertyType()

getValue

T getValue(PropertyHolder holder)

getValue

T getValue(PropertyHolder holder,
         T defaultValue)

setValue

void setValue(PropertyHolder holder,
            T value)

clearValue

void clearValue(PropertyHolder holder)

getStringValue

String getStringValue(DataContainer dataContainer,
                    PropertyHolder holder)

getStringValue

String getStringValue(DataContainer dataContainer,
                    String id)

getStringValue

String getStringValue(DataContainer dataContainer,
                    PropertyHolder holder,
                    String defaultValue)

getStringValue

String getStringValue(DataContainer dataContainer,
                    String id,
                    String defaultValue)

setStringValue

void setStringValue(DataContainer dataContainer,
                  PropertyHolder holder,
                  String value)

setStringValue

void setStringValue(DataContainer dataContainer,
                  String id,
                  String value)

getValue

T getValue(DataContainer dataContainer,
         PropertyHolder holder)

Get a value stored in a DataContainer. Please note that only certain types can be restored, @see PropertyConvertor class-

Throws:

UnsupportedOperationException - if the property does not support conversion from a string.

getValue

T getValue(DataContainer dataContainer,
         String id)

getValue

T getValue(DataContainer dataContainer,
         PropertyHolder holder,
         T defaultValue)

getValue

T getValue(DataContainer dataContainer,
         String id,
         T defaultValue)

setValue

void setValue(DataContainer dataContainer,
            PropertyHolder holder)

setValue

void setValue(DataContainer dataContainer,
            PropertyHolder holder,
            T value)

setValue

void setValue(DataContainer dataContainer,
            String id,
            T value)

clearValue

void clearValue(DataContainer dataContainer,
              PropertyHolder holder)

clearValue

void clearValue(DataContainer dataContainer,
              String id)

restoreValue

void restoreValue(DataContainer dataContainer,
                PropertyHolder holder)

Restores a value from a DataContainer back into the element. Note: this method is a mere shortcut of getValue(DataContainer) followed by a setValue(Node).

Throws:

UnsupportedOperationException - if the value type of this property can't be converted from a String.

RuntimeException - if any conversion errors occured.

See Also:

getValue

restoreValue

void restoreValue(DataContainer dataContainer,
                PropertyHolder holder,
                T defaultValue)