com.aldebaran.qi.serialization

Class MethodDescription

java.lang.Object

com.aldebaran.qi.serialization.MethodDescription

public class MethodDescription
extends Object

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 DISTANCE_PRIMITIVE_OBJECT.
• The distance between two numbers (double, float, ...) is DISTANCE_NUMBERS.
• The distance (for returned value only) between a type and a Future that embed this type is DISTANCE_FUTURE.
• The distance with a Tuple and QiStruct is DISTANCE_TUPLE_STRUCT
• For others case the distance becomes "infinite"

By example for libqi signature "call::s(i)":

Method Java	Distance
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')

Constructor Summary

Constructors

Constructor and Description
MethodDescription(String methodName, Class<?> returnType, Class<?>[] parametersType) Create method description.

Method Summary

Methods

Modifier and Type	Method and Description
int	distance(Method method) Compute the "distance" between the given method with this description. If "distance" is 0, it means the given method is exactly the method description. If "distance" is Integer.MAX_VALUE, if means the given method is completely different and incompatible. For other values of "distance" it means the given method is compatible to method description.
static MethodDescription	fromJNI(String methodName, String signatureJNI) Compute method description with method name and JNI signature.
String	getMethodName() Method name.
Class<?>[]	getParametersType() Method parameters types.
Class<?>	getReturnType() Method return type.
String	toString() String description for debug purpose

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodDescription

public MethodDescription(String methodName,
                 Class<?> returnType,
                 Class<?>[] parametersType)

Create method description.

Parameters:

methodName - Method name.

returnType - Method return type.

parametersType - Method parameters types.

Method Detail

fromJNI

public static MethodDescription fromJNI(String methodName,
                        String signatureJNI)

Compute method description with method name and JNI signature.

Parameters:

methodName - Method name.

signatureJNI - JNI signature.

Returns:

Method description created.

Throws:

IllegalArgumentException - If signatureJNI not a valid JNI signature.

getMethodName

public String getMethodName()

Method name.

Returns:

Method name.

getReturnType

public Class<?> getReturnType()

Method return type.

Returns:

Method return type.

getParametersType

public Class<?>[] getParametersType()

Method parameters types.

Returns:

Method parameters types.

distance

public int distance(Method method)

Compute the "distance" between the given method with this description.
If "distance" is 0, it means the given method is exactly the method description.
If "distance" is Integer.MAX_VALUE, if means the given method is completely different and incompatible.
For other values of "distance" it means the given method is compatible to method description. More the value is near 0, more the compatibility is easy.

Parameters:

method - Method to measure the "distance" with.

Returns:

The computed "distance".

toString

public String toString()

String description for debug purpose

Overrides:

toString in class Object

Returns:

String description for debug purpose