com.github.wuic.config

Class ObjectBuilderFactory<T>

java.lang.Object

com.github.wuic.config.ObjectBuilderFactory<T>

Type Parameters:

T - the type of objects produced by the builder

All Implemented Interfaces:

AnnotationProcessor

public class ObjectBuilderFactory<T>
extends Object
implements AnnotationProcessor

This factory creates builder for a particular type of object. All implementations of this type must be annotated with a specified annotation to be detected over the classpath.

Since:

0.5

Version:

1.0

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ObjectBuilderFactory.KnownType Data object that provides a detected service and the type name that identifies its builder.

Constructor Summary

Constructors

Constructor and Description
ObjectBuilderFactory(Class<? extends Annotation> annotationToScan, Class<? extends T>... classes) Builds a new instance.
ObjectBuilderFactory(Class<? extends Annotation> annotationToScan, String packageToScan) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectBuilder<T>	create(String type) Creates a builder for the given type.
void	handle(Class<?> annotatedType) Handles a type annotated with the required annotation.
ObjectBuilderFactory<T>	inspector(ObjectBuilderInspector i) Adds an inspector.
List<ObjectBuilderFactory.KnownType>	knownTypes() Returns all the supported types.
Class<? extends Annotation>	requiredAnnotation() The annotation that must be detected on type to be handled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectBuilderFactory

public ObjectBuilderFactory(Class<? extends Annotation> annotationToScan,
                    String packageToScan)

Builds a new instance.

Parameters:

annotationToScan - the annotation to discover

packageToScan - the package to scan

ObjectBuilderFactory

public ObjectBuilderFactory(Class<? extends Annotation> annotationToScan,
                    Class<? extends T>... classes)

Builds a new instance.

Parameters:

annotationToScan - the annotation to discover

classes - a list of classes to directly scan instead of discovering types by scanning classpath

Method Detail

inspector

public ObjectBuilderFactory<T> inspector(ObjectBuilderInspector i)

Adds an inspector.

Parameters:

i - the inspector

Returns:

this

knownTypes

public List<ObjectBuilderFactory.KnownType> knownTypes()

Returns all the supported types.

Returns:

the known types

requiredAnnotation

public Class<? extends Annotation> requiredAnnotation()

The annotation that must be detected on type to be handled.

Specified by:

requiredAnnotation in interface AnnotationProcessor

Returns:

the annotation

handle

public final void handle(Class<?> annotatedType)

Handles a type annotated with the required annotation.

Specified by:

handle in interface AnnotationProcessor

Parameters:

annotatedType - the annotated type

create

public ObjectBuilder<T> create(String type)

Creates a builder for the given type. The type is the simple name of the class produced by the builder. All supported type are detected during classpath scanning. If a type could not be registered, the cause is logged and when retrieved with this method, null will be returned.

Throws an IllegalArgumentException if the there is a bad usage of annotation or if the type is unknown

Parameters:

type - the type created by the builder

Returns:

the builder