com.aldebaran.qi

Class AnyObject

java.lang.Object

com.aldebaran.qi.AnyObject

All Implemented Interfaces:

Comparable<AnyObject>

public class AnyObject
extends Object
implements Comparable<AnyObject>

Class that provides type erasure on objects. It represents an object (understandable by the messaging layer) that has shared semantics and that can contain methods, signals and properties.

This class is typically used in Session when retrieving a remote service by its name. The service itself is not retrieved, but a reference to it, in order to call its methods, connect to its signals and access its properties. It is also used when creating and registering a new QiService.

Use DynamicObjectBuilder to create an instance of this class.

See Also:

DynamicObjectBuilder

Method Summary

Modifier and Type	Method and Description
<T> Future<T>	call(Class<T> targetType, String method, Object... args)
<T> Future<T>	call(QiSerializer serializer, Class<T> targetType, String method, Object... args)
<T> Future<T>	call(QiSerializer serializer, Type targetType, String method, Object... args) Convert structs in args to tuples if necessary, then call method asynchronously.
<T> Future<T>	call(String method, Object... args) Perform asynchronous call and return Future return value
<T> Future<T>	call(Type targetType, String method, Object... args)
int	compareTo(AnyObject anyObject) Compare this AnyObject with a given one. Comparison result is : ComparisonResult this < anyObject-1 this == anyObject0 this > anyObject1 QiSignalConnection connect(QiSerializer serializer, String signalName, Object annotatedSlotContainer, String slotName) QiSignalConnection connect(String signalName, Object annotatedSlotContainer, String slotName) QiSignalConnection connect(String signalName, QiSignalListener listener) static Object decodeJSON(String str) static String encodeJSON(Object obj) boolean equals(Object object) Indicates if given object is equals to this AnyObject protected void finalize() Called by garbage collector Finalize is overriden to manually delete C++ data <T> Future<T> getProperty(Class<T> targetType, String property) <T> Future<T> getProperty(QiSerializer serializer, Class<T> targetType, String property) <T> Future<T> getProperty(QiSerializer serializer, Type targetType, String property) Retrieve the value of property asynchronously. <T> Future<T> getProperty(Type targetType, String property) int hashCode() Returns a hash code value for this AnyObject. void post(QiSerializer qiSerializer, String eventName, Object... args) Post an event advertised with advertiseEvent method. void post(String eventName, Object... args) Post an event advertised with advertiseEvent method. <T> Future<T> property(String property) Future<Void> setProperty(QiSerializer valueConverter, String propertyName, Object newValue) Sets the AnyObject property with the given name, using a serializer to convert the value. Future<Void> setProperty(String propertyName, Object newValue) Sets a property of the AnyObject defined by a string, using the default serializer to convert the value. String toString() Methods inherited from class java.lang.Object clone, getClass, notify, notifyAll, wait, wait, wait Method Detail decodeJSON public static Object decodeJSON(String str) encodeJSON public static String encodeJSON(Object obj) setProperty public Future<Void> setProperty(QiSerializer valueConverter, String propertyName, Object newValue) Sets the AnyObject property with the given name, using a serializer to convert the value. Parameters: valueConverter - A converter that transforms `newValue` into a property value. propertyName - The property name. newValue - The object to convert as the new property value. Must not be null, unless the property value type is AnyObject. Returns: A future in error if the given value is null and the property value type is not `AnyObject`, or if no property with this name could be found. setProperty public Future<Void> setProperty(String propertyName, Object newValue) Sets a property of the AnyObject defined by a string, using the default serializer to convert the value. Parameters: propertyName - The property name. newValue - The object to convert as the new property value. Must not be null, unless the property value type is AnyObject. Returns: A future in error if the given value is null and the property value type is not `AnyObject`, or if no property with this name could be found. property public <T> Future<T> property(String property) getProperty public <T> Future<T> getProperty(QiSerializer serializer, Type targetType, String property) Retrieve the value of property asynchronously. Tuples will be converted to structs in the result, according to the targetType. Parameters: targetType - the target result type property - the property Returns: A future to the converted result. getProperty public <T> Future<T> getProperty(Type targetType, String property) getProperty public <T> Future<T> getProperty(QiSerializer serializer, Class<T> targetType, String property) getProperty public <T> Future<T> getProperty(Class<T> targetType, String property) call public <T> Future<T> call(String method, Object... args) Perform asynchronous call and return Future return value Parameters: method - Method name to call args - Arguments to be forward to remote method Returns: Future method return value Throws: DynamicCallException call public <T> Future<T> call(QiSerializer serializer, Type targetType, String method, Object... args) Convert structs in args to tuples if necessary, then call method asynchronously. Tuples will be converted to structs in the result, according to the targetType. Parameters: targetType - the target result type method - the method args - the method arguments Returns: a future to the converted result call public <T> Future<T> call(Type targetType, String method, Object... args) call public <T> Future<T> call(QiSerializer serializer, Class<T> targetType, String method, Object... args) call public <T> Future<T> call(Class<T> targetType, String method, Object... args) connect public QiSignalConnection connect(String signalName, QiSignalListener listener) connect public QiSignalConnection connect(QiSerializer serializer, String signalName, Object annotatedSlotContainer, String slotName) connect public QiSignalConnection connect(String signalName, Object annotatedSlotContainer, String slotName) post public void post(String eventName, Object... args) Post an event advertised with advertiseEvent method. Parameters: eventName - Name of the event to trigger. args - Arguments sent to callback See Also: DynamicObjectBuilder.advertiseSignal(long, String) post public void post(QiSerializer qiSerializer, String eventName, Object... args) Post an event advertised with advertiseEvent method. Parameters: qiSerializer - Serializer to use eventName - Name of the event to trigger. args - Arguments sent to callback See Also: DynamicObjectBuilder.advertiseSignal(long, String) toString public String toString() Overrides: toString in class Object finalize protected void finalize() throws Throwable Called by garbage collector Finalize is overriden to manually delete C++ data Overrides: finalize in class Object Throws: Throwable equals public boolean equals(Object object) Indicates if given object is equals to this AnyObject Overrides: equals in class Object Parameters: object - Object to compare with Returns: true if given object is equals compareTo public int compareTo(AnyObject anyObject) Compare this AnyObject with a given one. Comparison result is : Comparison Result this < anyObject -1 this == anyObject 0 this > anyObject 1 Specified by: compareTo in interface Comparable<AnyObject> Parameters: anyObject - AnyObject to compare with Returns: Comparison result hashCode public int hashCode() Returns a hash code value for this AnyObject. Overrides: hashCode in class Object Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2020. All rights reserved.