com.aldebaran.qi

Class Property<T>

java.lang.Object

com.aldebaran.qi.Property<T>

Type Parameters:

T - Property type. Be sure the type is: * One of default : Byte, Short, Int, Long, Float, Double, String, List, Map, Tuple, QiStruct. * Or managed by a QiSerializer.

public final class Property<T>
extends Object

Represents a property from distant object or can be advertised

Constructor Summary

Constructors

Constructor and Description
Property(Class<T> valueClass) Create an empty property with a class and the default serializer.
Property(Class<T> valueClass, QiSerializer serializer) Create a property with a class and a serializer.
Property(Class<T> valueClass, T value) Create a property with a class and a value and the default serializer.
Property(Class<T> valueClass, T value, QiSerializer serializer) Create a property with a class, a value and a serializer.
Property(T value) Create a property with a value and the default serializer.
Property(T value, QiSerializer serializer) Create a property with a value and a serializer.

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Called by JVM when object is garbage collected
QiSerializer	getSerializer() Current serializer.
Future<T>	getValue() Current property value.
Future<T>	getValue(QiSerializer qiSerializer) Current property value.
Future<Void>	setValue(QiSerializer qiSerializer, T value) Change property value
Future<Void>	setValue(T value) Change property value It will use the property serializer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(Class<T> valueClass,
                QiSerializer serializer)

Create a property with a class and a serializer.

Parameters:

valueClass - The property value class. Must not be null.

serializer - Serializer to use for the conversion of the property value. Must not be null.

Property

public Property(Class<T> valueClass)

Create an empty property with a class and the default serializer.

Parameters:

valueClass - The property value class.

Throws:

NullPointerException - if valueClass parameter is null.

Property

public Property(Class<T> valueClass,
                T value,
                QiSerializer serializer)

Create a property with a class, a value and a serializer.

Parameters:

valueClass - The property value class. Must not be null.

value - Value to initialize the property with. Must not be null, except for `Property` for which it may be.

serializer - Serializer to use for the conversion of the property value. Must not be null.

Throws:

a - customized NullPointerException if a parameter is null.

Property

public Property(T value,
                QiSerializer serializer)

Create a property with a value and a serializer.

Parameters:

value - Value to initialize the property with. Must not be null.

serializer - Serializer to use for the conversion of the property value. Must not be null.

Throws:

a - customized NullPointerException if a parameter is null.

Property

public Property(T value)

Create a property with a value and the default serializer.

Parameters:

value - Value to initialize the property with. Must not be null

Throws:

a - customized NullPointerException if a parameter is null.

Property

public Property(Class<T> valueClass,
                T value)

Create a property with a class and a value and the default serializer.

Parameters:

valueClass - The property value class. Must not be null.

value - Value to initialize the property with. Must not be null.

Throws:

a - customized NullPointerException if a parameter is null.

Method Detail

getSerializer

public QiSerializer getSerializer()

Current serializer.

Returns:

getValue

public Future<T> getValue()

Current property value. It will use the property serializer. For custom type use getValue(QiSerializer)

Returns:

Future to get the value

getValue

public Future<T> getValue(QiSerializer qiSerializer)

Current property value.

Parameters:

qiSerializer - Serializer to use for deserialize the value. Must not be null

Returns:

Future to get the value

setValue

public Future<Void> setValue(T value)

Change property value It will use the property serializer. For custom type use setValue(QiSerializer, Object)

Parameters:

value - New value. Warning may have strange result with null

Returns:

Future to know when value effectively set

setValue

public Future<Void> setValue(QiSerializer qiSerializer,
                             T value)

Change property value

Parameters:

qiSerializer - Serializer to use for serialize the value. Must not be null

value - New value. Must not be null, except for `Property` for which it may be.

Returns:

Future to know when value effectively set

finalize

protected void finalize()
                 throws Throwable

Called by JVM when object is garbage collected

Overrides:

finalize in class Object

Throws:

Throwable - On finalization issue