com.aldebaran.qi

Class DynamicObjectBuilder

java.lang.Object

com.aldebaran.qi.DynamicObjectBuilder

public class DynamicObjectBuilder
extends Object

Class that exposes directly an AnyObject that can be manipulated.

There is only one AnyObject per DynamicObjectBuilder, the object method always returns the same instance.

This class is typically used to subscribe a new QiService to a Session

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicObjectBuilder.ObjectThreadingModel Enum to declare the thread-safeness state of an AnyObject instance.

Constructor Summary

Constructors

Constructor and Description
DynamicObjectBuilder() Create the builder

Method Summary

Modifier and Type

Method and Description

void

advertiseMethod(String methodSignature, QiService service, String description) Bind method from a qimessaging.service to GenericObject. The given signature MUST be a libqi type signature AND use Java compatible types : libqi Java b Boolean c Character v void i Integer l Long f Float d Double s String o Object m Object (dynamic) [<type>] ArrayList {<key><type>} Map (<type>....) Tuple WARNING : If method not found, nothing happen. Be sure the method is unique in name, if two methods with same name and different signature, you can't be sure it choose the good one If method choose (by name) have not the correct Java signature, it will crash later (when call) <INTERFACE,INSTANCE extends INTERFACE> INTERFACE advertiseMethods(Class<INTERFACE> interfaceClass, INSTANCE instance) Deprecated. <INTERFACE,INSTANCE extends INTERFACE> INTERFACE advertiseMethods(QiSerializer serializer, Class<INTERFACE> interfaceClass, INSTANCE instance) Advertise methods from interface. All methods of given interface are automatically registered. To specify a description on method add AdvertisedMethodDescription annotation on the method. void advertiseProperty(String name, Class<?> propertyBase) Deprecated. Advertise a property <T> void advertiseProperty(String name, Property<T> property) Advertise a property Must be called before object() void advertiseSignal(String signalSignature) Advertise a signal with its callback signature. The given signature MUST be a libqi type signature protected void finalize() Called by garbage collector Finalize is overridden to manually delete C++ data AnyObject object() Instantiate new AnyObject after builder template. void setThreadingModel(DynamicObjectBuilder.ObjectThreadingModel threadModel) Declare the thread-safeness state of an instance Methods inherited from class java.lang.Object clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Constructor Detail DynamicObjectBuilder public DynamicObjectBuilder() Create the builder Method Detail advertiseMethod public void advertiseMethod(String methodSignature, QiService service, String description) Bind method from a qimessaging.service to GenericObject. The given signature MUST be a libqi type signature AND use Java compatible types : libqi Java b Boolean c Character v void i Integer l Long f Float d Double s String o Object m Object (dynamic) [<type>] ArrayList {<key><type>} Map (<type>....) Tuple WARNING : If method not found, nothing happen. Be sure the method is unique in name, if two methods with same name and different signature, you can't be sure it choose the good one If method choose (by name) have not the correct Java signature, it will crash later (when call) Parameters: methodSignature - Signature of method to bind. It must be a valid libqi type signature service - Service implementing method. description - Method description Throws: AdvertisementException - If signature is not a valid libqi signature type. SecurityException - If given service instance of a class protect from reflection advertiseSignal public void advertiseSignal(String signalSignature) throws Exception Advertise a signal with its callback signature. The given signature MUST be a libqi type signature Parameters: signalSignature - Signature of available callback. Throws: AdvertisementException - If signature not a valid libqi signature type. Exception - If GenericObject is not initialized internally. advertiseProperty @Deprecated public void advertiseProperty(String name, Class<?> propertyBase) Deprecated. Advertise a property Parameters: name - Property name propertyBase - Class warp the property advertiseProperty public <T> void advertiseProperty(String name, Property<T> property) Advertise a property Must be called before object() Type Parameters: T - Property type Parameters: name - Property name. Must not be null property - Property to share. Must not be null setThreadingModel public void setThreadingModel(DynamicObjectBuilder.ObjectThreadingModel threadModel) Declare the thread-safeness state of an instance Parameters: threadModel - if set to ObjectThreadingModel.MultiThread, your object is expected to be thread safe, and calls to its method will potentially occur in parallel in multiple threads. If false, qimessaging will use a per-instance mutex to prevent multiple calls at the same time. object public AnyObject object() Instantiate new AnyObject after builder template. Returns: AnyObject See Also: AnyObject finalize protected void finalize() throws Throwable Called by garbage collector Finalize is overridden to manually delete C++ data Overrides: finalize in class Object Throws: Throwable advertiseMethods @Deprecated public <INTERFACE,INSTANCE extends INTERFACE> INTERFACE advertiseMethods(Class<INTERFACE> interfaceClass, INSTANCE instance) Deprecated. Deprecated: Prefer use advertiseMethods(QiSerializer, Class, Object) with the good serializer Advertise methods from interface. All methods of given interface are automatically registered. To specify a description on method add AdvertisedMethodDescription annotation on the method. Type Parameters: INTERFACE - Interface type that specifies the list of methods to expose. INSTANCE - Instance type of interface. Parameters: interfaceClass - Interface that specifies the list of methods to expose. instance - Instance of interface implementation. Returns: Instance The instance passed as parameter. advertiseMethods public <INTERFACE,INSTANCE extends INTERFACE> INTERFACE advertiseMethods(QiSerializer serializer, Class<INTERFACE> interfaceClass, INSTANCE instance) Advertise methods from interface. All methods of given interface are automatically registered. To specify a description on method add AdvertisedMethodDescription annotation on the method. Type Parameters: INTERFACE - Interface type that specifies the list of methods to expose. INSTANCE - Instance type of interface. Parameters: serializer - Serializer to use interfaceClass - Interface that specifies the list of methods to expose. instance - Instance of interface implementation. Returns: Instance The instance passed as parameter. 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.