com.chemaxon.apidiscovery

Class Discovery

java.lang.Object

com.chemaxon.apidiscovery.Discovery

@Beta
 @PublicAPI
public final class Discovery
extends java.lang.Object

Utility methods for parameter discovery.

Please note that this class is marked with Beta annotation, so it can be subject of incompatible changes or removal in later releases.

Author:

Gabor Imre

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.Class<T> a, java.lang.Object o) Retrieve an annotation on an object.
static <T extends java.lang.annotation.Annotation> T	getAnnotationForClass(java.lang.Class<T> annotationClass, java.lang.Class<?> clazz) Retrieve annotation for a class.
static <T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T>	getAnnotationIfPresent(java.lang.Class<T> a, java.lang.Object o) Retrieve an annotation on an object if present.
static Description	getDescriptionAnnotation(java.lang.Object o) Retrieve the description annotation on an object.
static <T> com.google.common.base.Optional<ParameterBuilder<T>>	initializeBuilderIfExists(T o) Create initial Builder if possible.
static boolean	isParametrized(java.lang.Object o) Check if an object is parametrized.
static <T> java.util.List<CreatorWrapper<T>>	listCreators(java.lang.Object o, java.lang.Class<T> targetType) CreatorWrapper acts as a type-dependent service loader.
static <T> java.util.List<InstanceWrapper<T>>	listInstances(java.lang.Class<T> type) Collect instances of a specific type.
static java.util.List<ParameterWrapper>	listParameters(java.lang.Object o) Retrieve parameters for a mutable parameter object.
static <T> com.google.common.base.Optional<InstanceWrapper<T>>	selectInstance(java.lang.Class<T> type, java.lang.String shortName) Look up an instance by its short name.

Methods inherited from class java.lang.Object

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

Method Detail

listInstances

@Beta
public static <T> java.util.List<InstanceWrapper<T>> listInstances(java.lang.Class<T> type)

Collect instances of a specific type.

Type Parameters:

T - Type to collect

Parameters:

type - Type to collect

Returns:

One or more instances of the specified type. Interfaces are retrieved as services; classes are instantiated with their nullary constructors; enums are enumerated

selectInstance

public static <T> com.google.common.base.Optional<InstanceWrapper<T>> selectInstance(java.lang.Class<T> type,
                                                                                     java.lang.String shortName)

Look up an instance by its short name.

Type Parameters:

T - Type to collect

Parameters:

type - Type to collect (by listInstances(java.lang.Class)

shortName - Short name of the instance to select

Returns:

The first matching instance if found

isParametrized

@Beta
public static boolean isParametrized(java.lang.Object o)

Check if an object is parametrized.

Parameters:

o - Object in question

Returns:

true if o is parametrized

listParameters

@Beta
public static java.util.List<ParameterWrapper> listParameters(java.lang.Object o)

Retrieve parameters for a mutable parameter object. Parameter set mode is specified by Parametrized.parameterSetMode() on the objects Parametrized annotation.

Parameters:

o - Mutable parametrized object annotated with Parametrized

Returns:

Parameters of o wrapped

Throws:

java.lang.IllegalArgumentException - when o is not annotated with Parametrized or no parameters found

getAnnotationForClass

@Beta
public static <T extends java.lang.annotation.Annotation> T getAnnotationForClass(java.lang.Class<T> annotationClass,
                                                                                        java.lang.Class<?> clazz)

Retrieve annotation for a class. Note that enum constants are not handled by this method.

Type Parameters:

T - Annotation class

Parameters:

annotationClass - Annotation class

clazz - Target class

Returns:

Annotation retrieved

Throws:

java.lang.IllegalArgumentException - when no Description annotation found

getAnnotationIfPresent

@Beta
public static <T extends java.lang.annotation.Annotation> com.google.common.base.Optional<T> getAnnotationIfPresent(java.lang.Class<T> a,
                                                                                                                          java.lang.Object o)

Retrieve an annotation on an object if present.

Type Parameters:

T - Annotation class

Parameters:

a - Annotation class

o - Object to examine

Returns:

The description annotation if exist

getAnnotation

@Beta
public static <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> a,
                                                                                java.lang.Object o)

Retrieve an annotation on an object.

Type Parameters:

T - Annotation class

Parameters:

a - Annotation class

o - Object to examine

Returns:

The annotation if exists or null; If o is an instance of an enum then enum constant annotation is retrieved

Throws:

java.lang.IllegalArgumentException - when no annotation found

getDescriptionAnnotation

@Beta
public static Description getDescriptionAnnotation(java.lang.Object o)

Retrieve the description annotation on an object.

Parameters:

o - Object to examine

Returns:

The description annotation if exists or null; If o is an instance of an enum then enum constant annotation is retrieved

Throws:

java.lang.IllegalArgumentException - when no Description annotation found

listCreators

@Beta
public static <T> java.util.List<CreatorWrapper<T>> listCreators(java.lang.Object o,
                                                                       java.lang.Class<T> targetType)

CreatorWrapper acts as a type-dependent service loader.

Note that the order of the returned list is defined by

Type Parameters:

T - type to be created

Parameters:

targetType - type to be created

o - Instance on which the creators should be called

Returns:

All distinct creator parameters

initializeBuilderIfExists

@Beta
public static <T> com.google.common.base.Optional<ParameterBuilder<T>> initializeBuilderIfExists(T o)

Create initial Builder if possible.

Builder association is identified by annotation BuilderClass

Type Parameters:

T - Parameter object type

Parameters:

o - An object

Returns:

An associated builder instance if the parameter object has associated builder.