Describe a method.
It contains the method name, return type and parameters type.
For choose the best method that corresponds to a search one, we compute a "distance" between methods:
This "distance" is build for when match exactly, the distance is 0.
If the two methods have different name or different number of parameters the distance is
"infinite".
The distance between primitive and their associated Object (For example int <-> java.lang.Integer, boolean <-> java.lang.Boolean, ...) is
MethodDescription.DISTANCE_PRIMITIVE_OBJECT.
The distance between two numbers (double, float, ...) is
MethodDescription.DISTANCE_NUMBERS.
The distance (for returned value only) between a type and a Future that embed this type is
MethodDescription.DISTANCE_FUTURE.
The distance with a
Tuple and
QiStruct is
MethodDescription.DISTANCE_TUPLE_STRUCT
For others case the distance becomes
"infinite"
By example for libqi signature "call::s(i)":
Method JavaDistance
String call(int i)0 = 0 (Distance String and 's') + 0 (Distance int and 'i')
String call(Integer i)1 = 0 (Distance String and 's') + 1 (Distance Integer and 'i')
Future<String> call(int i)100 = 100 (Distance Future<String> and 's') + 0 (Distance int and 'i')
Future<String> call(Integer i)101 = 100 (Distance Future<String> and 's') + 1 (Distance Integer and 'i')
MethodDescription(String, Class<?>, Class<?>[]) - Constructor for class com.aldebaran.qi.serialization.MethodDescription
Create method description.
moreImportant() - Method in enum com.aldebaran.qi.log.LogLevel
Obtain level more important in hierarchy
N
- NativeTools - Class in com.aldebaran.qi
-
Utilities tools to communicate with native code (Code in C++)
- NativeTools() - Constructor for class com.aldebaran.qi.NativeTools
-
- newAuthenticator() - Method in class com.aldebaran.qi.ClientAuthenticatorFactory
-
O
- object() - Method in class com.aldebaran.qi.DynamicObjectBuilder
-
Instantiate new AnyObject after builder template.
- OBJECT - Static variable in class com.aldebaran.qi.serialization.SignatureUtilities
-
Libqi Object signature
- obtainLogLevel(int) - Static method in enum com.aldebaran.qi.log.LogLevel
-
- of(T) - Static method in class com.aldebaran.qi.Future
-
- of(T) - Static method in class com.aldebaran.qi.Optional
-
- of(Object...) - Static method in class com.aldebaran.qi.Tuple
-
Create a tuple from its values.
- ofNullable(T) - Static method in class com.aldebaran.qi.Optional
-
- onCancelRequested(Promise<T>) - Method in interface com.aldebaran.qi.Promise.CancelRequestCallback
-
- onConnected() - Method in interface com.aldebaran.qi.Session.ConnectionListener
-
- onDisconnected(String) - Method in interface com.aldebaran.qi.Session.ConnectionListener
-
- onDisconnected(String, Object) - Method in class com.aldebaran.qi.Session
-
Deprecated.
- onFinished(Future<T>) - Method in interface com.aldebaran.qi.Future.Callback
-
- onSignalReceived(Object...) - Method in interface com.aldebaran.qi.QiSignalListener
-
- Optional<T> - Class in com.aldebaran.qi
-
For documentation purpose, please refer to
https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html
TODO : remove when java 1.8
- OptionalConverter - Class in com.aldebaran.qi.serialization
-
- OptionalConverter() - Constructor for class com.aldebaran.qi.serialization.OptionalConverter
-
- or(Supplier<? extends Optional<? extends T>>) - Method in class com.aldebaran.qi.Optional
-
- orElse(T) - Method in class com.aldebaran.qi.Optional
-
- orElseGet(Supplier<? extends T>) - Method in class com.aldebaran.qi.Optional
-
- orElseThrow(Supplier<? extends X>) - Method in class com.aldebaran.qi.Optional
-
P
- post(String, Object...) - Method in class com.aldebaran.qi.AnyObject
-
Post an event advertised with advertiseEvent method.
- post(QiSerializer, String, Object...) - Method in class com.aldebaran.qi.AnyObject
-
Post an event advertised with advertiseEvent method.
- Predicate<T> - Interface in com.aldebaran.qi
-
Represents a predicate (boolean-valued function) of one argument.
- Promise<T> - Class in com.aldebaran.qi
-
Promise is a writable, single assignment container which sets the value of
the
Future.
- Promise(FutureCallbackType) - Constructor for class com.aldebaran.qi.Promise
-
Create a new promise
- Promise() - Constructor for class com.aldebaran.qi.Promise
-
- Promise.CancelRequestCallback<T> - Interface in com.aldebaran.qi
-
An implementation of this interface can be connected to a
Promise
in order to be called when the
Promise receives a cancel request.
- property(String) - Method in class com.aldebaran.qi.AnyObject
-
- Property<T> - Class in com.aldebaran.qi
-
Represents a property from distant object or can be advertised
- Property(Class<T>) - Constructor for class com.aldebaran.qi.Property
-
Create an empty property.
- Property(T) - Constructor for class com.aldebaran.qi.Property
-
Create a property with a value.
- Property(Class<T>, T) - Constructor for class com.aldebaran.qi.Property
-
Create a property with a class and a value.
Q
- QiConversionException - Exception in com.aldebaran.qi
-
A QiConversionException is an exception indicating that a custom
object could not be serialized and deserialized to or from a supported type.
- QiConversionException() - Constructor for exception com.aldebaran.qi.QiConversionException
-
Constructs a QiConversionException.
- QiConversionException(String, Throwable) - Constructor for exception com.aldebaran.qi.QiConversionException
-
Constructs a QiConversionException with the specified detail message
and cause.
- QiConversionException(String) - Constructor for exception com.aldebaran.qi.QiConversionException
-
Constructs a QiConversionException with the specified detail message.
- QiConversionException(Throwable) - Constructor for exception com.aldebaran.qi.QiConversionException
-
Constructs a QiConversionException with the specified cause.
- QiException - Exception in com.aldebaran.qi
-
QiException is a subclass of the standard Java
Exception.
- QiException() - Constructor for exception com.aldebaran.qi.QiException
-
Constructs a QiException.
- QiException(String, Throwable) - Constructor for exception com.aldebaran.qi.QiException
-
Constructs a QiException with the specified detail message
and cause.
- QiException(String) - Constructor for exception com.aldebaran.qi.QiException
-
Constructs a QiException with the specified detail message.
- QiException(Throwable) - Constructor for exception com.aldebaran.qi.QiException
-
Constructs a QiException with the specified cause.
- QiField - Annotation Type in com.aldebaran.qi
-
Annotation indicating that a field represents an element inside a
Tuple.
- QiRuntimeException - Exception in com.aldebaran.qi
-
- QiRuntimeException() - Constructor for exception com.aldebaran.qi.QiRuntimeException
-
Constructs a QiRuntimeException.
- QiRuntimeException(String, Throwable) - Constructor for exception com.aldebaran.qi.QiRuntimeException
-
Constructs a QiRuntimeException with the specified detail message
and cause.
- QiRuntimeException(String) - Constructor for exception com.aldebaran.qi.QiRuntimeException
-
Constructs a QiRuntimeException with the specified detail message.
- QiRuntimeException(Throwable) - Constructor for exception com.aldebaran.qi.QiRuntimeException
-
Constructs a QiRuntimeException with the specified cause.
- QiSerializer - Class in com.aldebaran.qi.serialization
-
Class that provides methods to serialize and deserialize custom objects to and from supported
types.
- QiSerializer(List<QiSerializer.Converter>) - Constructor for class com.aldebaran.qi.serialization.QiSerializer
-
- QiSerializer() - Constructor for class com.aldebaran.qi.serialization.QiSerializer
-
- QiSerializer.Converter - Interface in com.aldebaran.qi.serialization
-
Converter interface which defines the characteristics of a converter.
- QiService - Class in com.aldebaran.qi
-
Interface used to create a service that can be registered to a
Session
- QiService() - Constructor for class com.aldebaran.qi.QiService
-
- QiSignalConnection - Class in com.aldebaran.qi
-
Class that represents a connection to a signal.
- QiSignalListener - Interface in com.aldebaran.qi
-
An implementation of this interface can be set as a callback to be invoked
every time the specified signal is triggered.
- QiSlot - Annotation Type in com.aldebaran.qi
-
Annotation indicating that a method can be used as a signal's callback.
- QiSlotException - Exception in com.aldebaran.qi
-
- QiSlotException() - Constructor for exception com.aldebaran.qi.QiSlotException
-
Constructs a QiSlotException
- QiSlotException(String, Throwable) - Constructor for exception com.aldebaran.qi.QiSlotException
-
Constructs a QiSlotException with the specified detail message and
cause.
- QiSlotException(String) - Constructor for exception com.aldebaran.qi.QiSlotException
-
Constructs a QiSlotException with the specified detail message.
- QiSlotException(Throwable) - Constructor for exception com.aldebaran.qi.QiSlotException
-
Constructs a QiSlotException with the specified cause.
- QiStruct - Annotation Type in com.aldebaran.qi
-
Annotation indicating that a class represents a conversion from a
Tuple.
R
- RawApplication - Class in com.aldebaran.qi
-
Class responsible for initializing the qi framework, but without creating a
Session.
- RawApplication(String[]) - Constructor for class com.aldebaran.qi.RawApplication
-
RawApplication constructor.
- register(LogCatcher, LogLevel...) - Static method in class com.aldebaran.qi.log.LogReport
-
- registerAtLeast(LogCatcher, LogLevel) - Static method in class com.aldebaran.qi.log.LogReport
-
- registerService(String, AnyObject) - Method in class com.aldebaran.qi.Session
-
Register service on Service Directory
- removeConnectionListener(Session.ConnectionListener) - Method in class com.aldebaran.qi.Session
-
- requestCancellation() - Method in class com.aldebaran.qi.Future
-
Sends asynchronously a request to cancel the execution of this task.
- run() - Method in class com.aldebaran.qi.Application
-
Blocking function.
- run() - Method in class com.aldebaran.qi.RawApplication
-
Blocking function.
S
- self - Variable in class com.aldebaran.qi.QiService
-
- serialize(QiSerializer, Object) - Method in class com.aldebaran.qi.serialization.ArrayConverter
-
- serialize(QiSerializer, Object) - Method in class com.aldebaran.qi.serialization.ListConverter
-
- serialize(QiSerializer, Object) - Method in class com.aldebaran.qi.serialization.MapConverter
-
- serialize(QiSerializer, Object) - Method in class com.aldebaran.qi.serialization.OptionalConverter
-
Creates an optional object adapted from an optional object object.
- serialize(QiSerializer, Object) - Method in interface com.aldebaran.qi.serialization.QiSerializer.Converter
-
- serialize(Object) - Method in class com.aldebaran.qi.serialization.QiSerializer
-
- serialize(QiSerializer, Object) - Method in class com.aldebaran.qi.serialization.StructConverter
-
- service(String) - Method in class com.aldebaran.qi.Session
-
Ask for remote service to Service Directory.
- ServiceDirectory - Class in com.aldebaran.qi
-
Class responsible for the administration of the available services in a
Session.
- ServiceDirectory() - Constructor for class com.aldebaran.qi.ServiceDirectory
-
- session() - Method in class com.aldebaran.qi.Application
-
- Session - Class in com.aldebaran.qi
-
Class that allows using the messaging layer: it is responsible for connecting
services together locally or over the network.
- Session() - Constructor for class com.aldebaran.qi.Session
-
Create a qimessaging session.
- Session(long) - Constructor for class com.aldebaran.qi.Session
-
- Session.ConnectionListener - Interface in com.aldebaran.qi
-
- set(int, T) - Method in class com.aldebaran.qi.Tuple
-
- setCancelled() - Method in class com.aldebaran.qi.Promise
-
- setClientAuthenticator(ClientAuthenticator) - Method in class com.aldebaran.qi.Session
-
- setClientAuthenticatorFactory(ClientAuthenticatorFactory) - Method in class com.aldebaran.qi.Session
-
- setError(String) - Method in class com.aldebaran.qi.Promise
-
- setLogCategory(String, long) - Static method in class com.aldebaran.qi.Application
-
Crude interface to native log system
- setOnCancel(Promise.CancelRequestCallback<T>) - Method in class com.aldebaran.qi.Promise
-
Sets a cancel callback.
- setProperty(QiSerializer, String, Object) - Method in class com.aldebaran.qi.AnyObject
-
- setProperty(String, Object) - Method in class com.aldebaran.qi.AnyObject
-
- setThreadingModel(DynamicObjectBuilder.ObjectThreadingModel) - Method in class com.aldebaran.qi.DynamicObjectBuilder
-
Declare the thread-safeness state of an instance
- setValue(T) - Method in class com.aldebaran.qi.Promise
-
- setValue(T) - Method in class com.aldebaran.qi.Property
-
Change property value
Here it used the default serializer, so it suppose that the property type
is managed by it.
- setValue(QiSerializer, T) - Method in class com.aldebaran.qi.Property
-
Change property value
- SignatureUtilities - Class in com.aldebaran.qi.serialization
-
Utilities for manipulates signatures
- SignatureUtilities() - Constructor for class com.aldebaran.qi.serialization.SignatureUtilities
-
- size() - Method in class com.aldebaran.qi.Tuple
-
- start() - Method in class com.aldebaran.qi.Application
-
Start Application eventloops and connects the Session
- stop() - Method in class com.aldebaran.qi.Application
-
Stop Application eventloops and calls atStop() callbacks.
- stop() - Method in class com.aldebaran.qi.RawApplication
-
Stop RawApplication eventloops and calls atStop() callbacks.
- STRING - Static variable in class com.aldebaran.qi.serialization.SignatureUtilities
-
Libqi String signature
- StructConverter - Class in com.aldebaran.qi.serialization
-
Converter for Struct and Tuple serialization.
- StructConverter() - Constructor for class com.aldebaran.qi.serialization.StructConverter
-
- Supplier<T> - Interface in com.aldebaran.qi
-
Represents a supplier of results.
- sync(long, TimeUnit) - Method in class com.aldebaran.qi.Future
-
- sync() - Method in class com.aldebaran.qi.Future
-
T
- test(T) - Method in interface com.aldebaran.qi.Predicate
-
Evaluates this predicate on the given argument.
- thenApply(Function<Future<T>, R>) - Method in class com.aldebaran.qi.Future
-
Launch a task when the task link when this future finished (succeed,
error or cancelled)
- thenCompose(Function<Future<T>, Future<R>>) - Method in class com.aldebaran.qi.Future
-
Launch a task when the task link when this future finished (succeed,
error or cancelled).
Instead of return a Future>, it will automatically unwrap the
result to have a Future<R>
- thenConsume(Consumer<Future<T>>) - Method in class com.aldebaran.qi.Future
-
Launch a task when the task link when this future finished (succeed,
error or cancelled)
- toString() - Method in class com.aldebaran.qi.AnyObject
-
- toString() - Method in class com.aldebaran.qi.Optional
-
- toString() - Method in class com.aldebaran.qi.serialization.MethodDescription
-
String description for debug purpose
- toString() - Method in class com.aldebaran.qi.Tuple
-
- Tuple - Class in com.aldebaran.qi
-
Class that represents a list of values of different fixed types.
- Tuple(int) - Constructor for class com.aldebaran.qi.Tuple
-
- TypeToken<T> - Class in com.aldebaran.qi
-
Class used to represent a generic type T and to extract its type
information at runtime.
- TypeToken() - Constructor for class com.aldebaran.qi.TypeToken
-
U
- unregister(LogCatcher, LogLevel...) - Static method in class com.aldebaran.qi.log.LogReport
-
- unregisterAll(LogCatcher) - Static method in class com.aldebaran.qi.log.LogReport
-
Unregister all log level that a given
LogCatcher is registered
for
- unregisterAtMost(LogCatcher, LogLevel) - Static method in class com.aldebaran.qi.log.LogReport
-
- unregisterService(int) - Method in class com.aldebaran.qi.Session
-
Unregister service from Service Directory
- UserTokenAuthenticator - Class in com.aldebaran.qi
-
- UserTokenAuthenticator(String, String) - Constructor for class com.aldebaran.qi.UserTokenAuthenticator
-
Constructs an authenticator with the specified user and token.
- UserTokenAuthenticator(String) - Constructor for class com.aldebaran.qi.UserTokenAuthenticator
-
Deprecated.
since 3.1.1, use the constructor that takes both user and token arguments
- UtilReflexion - Class in com.aldebaran.qi.util
-
- UtilReflexion() - Constructor for class com.aldebaran.qi.util.UtilReflexion
-
V
- valueOf(String) - Static method in enum com.aldebaran.qi.DynamicObjectBuilder.ObjectThreadingModel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.aldebaran.qi.FutureCallbackType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.aldebaran.qi.log.LogLevel
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.aldebaran.qi.DynamicObjectBuilder.ObjectThreadingModel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.aldebaran.qi.FutureCallbackType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.aldebaran.qi.log.LogLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- verbose(String) - Static method in class com.aldebaran.qi.log.LogReport
-
Publish a verbose log
- VOID - Static variable in class com.aldebaran.qi.serialization.SignatureUtilities
-
Libqi void signature
W
- waitAll(Future<?>...) - Static method in class com.aldebaran.qi.Future
-
Wait for all futures to complete.
- waitFor(Future<?>...) - Method in class com.aldebaran.qi.Future
-
Return a version of this future that waits until futures
to finish.
- waitForDone() - Method in class com.aldebaran.qi.QiSignalConnection
-
- waitForService(String) - Method in class com.aldebaran.qi.Session
-
Create future for wait a service is ready to use.
- warning(String) - Static method in class com.aldebaran.qi.log.LogReport
-
Publish a warning log
_
- _processAuth(Map<String, Object>) - Method in interface com.aldebaran.qi.ClientAuthenticator
-
- _processAuth(Map<String, Object>) - Method in class com.aldebaran.qi.UserTokenAuthenticator
-
A B C D E F G H I L M N O P Q R S T U V W _
Copyright © 2019. All rights reserved.