org.jadira.bindings.core.cdi

Class BinderExtension

java.lang.Object

org.jadira.bindings.core.cdi.BinderExtension

All Implemented Interfaces:

javax.enterprise.inject.spi.Extension, Binder, ConversionBinder, RegisterableBinder, SearchableBinder, StringBinder

public class BinderExtension
extends Object
implements javax.enterprise.inject.spi.Extension, Binder, RegisterableBinder

A CDI Portable Extension that inspects beans being loaded by the container for bindings.

Constructor Summary

Constructors

Constructor and Description
BinderExtension() Create a new instance of BinderExtension

Method Summary

Modifier and Type	Method and Description
<T> T	convertFromString(Class<T> output, String object) Convert a String to the given target class
<T> T	convertFromString(Class<T> output, String object, Class<? extends Annotation> qualifier) Convert a String to the given target class
<S,T> T	convertTo(Class<S> sourceClass, Class<T> target, Object object) Convert an object which is an instance of source class to the given target class
<S,T> T	convertTo(Class<S> sourceClass, Class<T> target, Object object, Class<? extends Annotation> qualifier) Convert an object which is an instance of source class to the given target class
<S,T> T	convertTo(Class<T> output, Object object) Convert an object to the given target class This method infers the source type for the conversion from the runtime type of object.
<S,T> T	convertTo(Class<T> output, Object object, Class<? extends Annotation> qualifier) Convert an object to the given target class This method infers the source type for the conversion from the runtime type of object.
<S,T> T	convertTo(ConverterKey<S,T> key, Object object) Convert an object which is an instance of source class to the given target class
<S> String	convertToString(Class<S> input, Object object) Convert an object which is an instance of source class to String
<S> String	convertToString(Class<S> input, Object object, Class<? extends Annotation> qualifier) Convert an object which is an instance of source class to String
String	convertToString(Object object) Convert an object to String This method infers the source type for the conversion from the runtime type of object.
String	convertToString(Object object, Class<? extends Annotation> qualifier) Convert an object to String This method infers the source type for the conversion from the runtime type of object.
<S,T> Binding<S,T>	findBinding(Class<S> source, Class<T> target) Resolve a Binding with the given source and target class.
<S,T> Binding<S,T>	findBinding(Class<S> source, Class<T> target, Class<? extends Annotation> qualifier) Resolve a Binding with the given source and target class.
<S,T> Binding<S,T>	findBinding(ConverterKey<S,T> key) Resolve a Binding with the given source and target class.
<S,T> Converter<S,T>	findConverter(Class<S> source, Class<T> target) Resolve a Converter with the given input and output classes.
<S,T> Converter<S,T>	findConverter(Class<S> source, Class<T> target, Class<? extends Annotation> qualifier) Resolve a Converter with the given input and output classes.
<S,T> Converter<S,T>	findConverter(ConverterKey<S,T> key) Resolve a Converter with the given input and output classes.
<S,T> ToMarshaller<S,T>	findMarshaller(Class<S> source, Class<T> target) Resolve a Marshaller with the given source and target class.
<S,T> ToMarshaller<S,T>	findMarshaller(Class<S> source, Class<T> target, Class<? extends Annotation> qualifier) Resolve a Marshaller with the given source and target class.
<S,T> ToMarshaller<S,T>	findMarshaller(ConverterKey<S,T> key) Resolve a Marshaller with the given source and target class.
<S,T> FromUnmarshaller<S,T>	findUnmarshaller(Class<S> source, Class<T> target) Resolve an UnMarshaller with the given source and target class.
<S,T> FromUnmarshaller<S,T>	findUnmarshaller(Class<S> source, Class<T> target, Class<? extends Annotation> qualifier) Resolve an UnMarshaller with the given source and target class.
<S,T> FromUnmarshaller<S,T>	findUnmarshaller(ConverterKey<S,T> key) Resolve an UnMarshaller with the given source and target class.
Iterable<ConverterKey<?,?>>	getConverterEntries() Return an iterable collection of ConverterKeys, one for each currently registered conversion
<T,E> void	processAnnotatedType(javax.enterprise.inject.spi.ProcessAnnotatedType<T> pat)
void	registerAnnotatedClasses(Class<?>... classesToInspect) Inspect each of the supplied classes, processing any of the annotated methods found
<S,T> void	registerBinding(Class<S> sourceClass, Class<T> targetClass, Binding<S,T> converter) Register a Binding with the given source and target class.
<S,T> void	registerBinding(Class<S> sourceClass, Class<T> targetClass, Binding<S,T> converter, Class<? extends Annotation> qualifier) Register a Binding with the given source and target class.
<S,T> void	registerBinding(ConverterKey<S,T> key, Binding<S,T> converter) Register a Binding with the given source and target class.
void	registerConfiguration(URL nextLocation) Register the configuration file (bindings.xml) at the given URL
<S,T> void	registerConverter(Class<S> sourceClass, Class<T> targetClass, Converter<S,T> converter) Register a Converter with the given input and output classes.
<S,T> void	registerConverter(Class<S> sourceClass, Class<T> targetClass, Converter<S,T> converter, Class<? extends Annotation> qualifier) Register a Converter with the given input and output classes.
<S,T> void	registerConverter(ConverterKey<S,T> key, Converter<S,T> converter) Register a Converter with the given input and output classes.
<S,T> void	registerMarshaller(Class<S> sourceClass, Class<T> targetClass, ToMarshaller<S,T> converter) Register a Marshaller with the given source and target class.
<S,T> void	registerMarshaller(Class<S> sourceClass, Class<T> targetClass, ToMarshaller<S,T> converter, Class<? extends Annotation> qualifier) Register a Marshaller with the given source and target class.
<S,T> void	registerMarshaller(ConverterKey<S,T> key, ToMarshaller<S,T> converter) Register a Marshaller with the given source and target class.
<S,T> void	registerUnmarshaller(Class<S> sourceClass, Class<T> targetClass, FromUnmarshaller<S,T> converter) Register an UnMarshaller with the given source and target class.
<S,T> void	registerUnmarshaller(Class<S> sourceClass, Class<T> targetClass, FromUnmarshaller<S,T> converter, Class<? extends Annotation> qualifier) Register an UnMarshaller with the given source and target class.
<S,T> void	registerUnmarshaller(ConverterKey<S,T> key, FromUnmarshaller<S,T> converter) Register an UnMarshaller with the given source and target class.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinderExtension

public BinderExtension()

Create a new instance of BinderExtension

Method Detail

processAnnotatedType

public <T,E> void processAnnotatedType(@Observes
                                       javax.enterprise.inject.spi.ProcessAnnotatedType<T> pat)

convertTo

public <S,T> T convertTo(Class<T> output,
                         Object object)

Convert an object to the given target class This method infers the source type for the conversion from the runtime type of object.

Specified by:

convertTo in interface ConversionBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

output - The target class to convert the object to

object - The object to be converted

Returns:

The result of the conversion

convertTo

public <S,T> T convertTo(Class<T> output,
                         Object object,
                         Class<? extends Annotation> qualifier)

Convert an object to the given target class This method infers the source type for the conversion from the runtime type of object.

Specified by:

convertTo in interface ConversionBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

output - The target class to convert the object to

object - The object to be converted

qualifier - The qualifier for which the binding must be registered

Returns:

The result of the conversion

convertTo

public <S,T> T convertTo(Class<S> sourceClass,
                         Class<T> target,
                         Object object)

Convert an object which is an instance of source class to the given target class

Specified by:

convertTo in interface ConversionBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

sourceClass - The class of the object to be converted

target - The target class to convert the object to

object - The object to be converted

Returns:

The result of the conversion

convertTo

public <S,T> T convertTo(Class<S> sourceClass,
                         Class<T> target,
                         Object object,
                         Class<? extends Annotation> qualifier)

Convert an object which is an instance of source class to the given target class

Specified by:

convertTo in interface ConversionBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

sourceClass - The class of the object to be converted

target - The target class to convert the object to

object - The object to be converted

qualifier - Match the converter with the given qualifier

Returns:

The result of the conversion

convertTo

public <S,T> T convertTo(ConverterKey<S,T> key,
                         Object object)

Convert an object which is an instance of source class to the given target class

Specified by:

convertTo in interface ConversionBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

key - The converter key

object - The object to be converted

Returns:

The result of the conversion

findBinding

public <S,T> Binding<S,T> findBinding(Class<S> source,
                                      Class<T> target)

Resolve a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding.
The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

findBinding in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (owning) class

target - The target (foreign) class

Returns:

The found Binding

findMarshaller

public <S,T> ToMarshaller<S,T> findMarshaller(Class<S> source,
                                              Class<T> target)

Resolve a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findMarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (input) class

target - The target (output) class

Returns:

The found Marshaller

findConverter

public <S,T> Converter<S,T> findConverter(Class<S> source,
                                          Class<T> target)

Resolve a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

findConverter in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The input class

target - The output class

Returns:

The found Converter

findUnmarshaller

public <S,T> FromUnmarshaller<S,T> findUnmarshaller(Class<S> source,
                                                    Class<T> target)

Resolve an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findUnmarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (input) class

target - The target (output) class

Returns:

The found Unmarshaller

findBinding

public <S,T> Binding<S,T> findBinding(Class<S> source,
                                      Class<T> target,
                                      Class<? extends Annotation> qualifier)

Resolve a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding.
The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

findBinding in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (owning) class

target - The target (foreign) class

qualifier - The qualifier for which the binding must be registered

Returns:

The found Binding

findBinding

public <S,T> Binding<S,T> findBinding(ConverterKey<S,T> key)

Resolve a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding. The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

findBinding in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

key - The converter key

Returns:

The found Binding

findMarshaller

public <S,T> ToMarshaller<S,T> findMarshaller(Class<S> source,
                                              Class<T> target,
                                              Class<? extends Annotation> qualifier)

Resolve a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findMarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (input) class

target - The target (output) class

qualifier - The qualifier for which the marshaller must be registered

Returns:

The found Marshaller

findMarshaller

public <S,T> ToMarshaller<S,T> findMarshaller(ConverterKey<S,T> key)

Resolve a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findMarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

key - The converter key

Returns:

The found Marshaller

findConverter

public <S,T> Converter<S,T> findConverter(Class<S> source,
                                          Class<T> target,
                                          Class<? extends Annotation> qualifier)

Resolve a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

findConverter in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The input class

target - The output class

qualifier - The qualifier for which the marshaller must be registered

Returns:

The found Converter

findConverter

public <S,T> Converter<S,T> findConverter(ConverterKey<S,T> key)

Resolve a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

findConverter in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

key - The converter key

Returns:

The found Converter

findUnmarshaller

public <S,T> FromUnmarshaller<S,T> findUnmarshaller(Class<S> source,
                                                    Class<T> target,
                                                    Class<? extends Annotation> qualifier)

Resolve an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findUnmarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

source - The source (input) class

target - The target (output) class

qualifier - The qualifier for which the unmarshaller must be registered

Returns:

The found Unmarshaller

findUnmarshaller

public <S,T> FromUnmarshaller<S,T> findUnmarshaller(ConverterKey<S,T> key)

Resolve an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

findUnmarshaller in interface SearchableBinder

Type Parameters:

S - The Source type

T - The Target type

Parameters:

key - The converter key

Returns:

The found Unmarshaller

registerConfiguration

public void registerConfiguration(URL nextLocation)

Register the configuration file (bindings.xml) at the given URL

Specified by:

registerConfiguration in interface RegisterableBinder

Parameters:

nextLocation - The URL to register

registerBinding

public <S,T> void registerBinding(Class<S> sourceClass,
                                  Class<T> targetClass,
                                  Binding<S,T> converter)

Register a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding. The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

registerBinding in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (owning) class

targetClass - The target (foreign) class

converter - The binding to be registered

registerUnmarshaller

public <S,T> void registerUnmarshaller(Class<S> sourceClass,
                                       Class<T> targetClass,
                                       FromUnmarshaller<S,T> converter)

Register an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerUnmarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The FromUnmarshaller to be registered

registerMarshaller

public <S,T> void registerMarshaller(Class<S> sourceClass,
                                     Class<T> targetClass,
                                     ToMarshaller<S,T> converter)

Register a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerMarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The ToMarshaller to be registered

registerConverter

public <S,T> void registerConverter(Class<S> sourceClass,
                                    Class<T> targetClass,
                                    Converter<S,T> converter)

Register a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

registerConverter in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The Converter to be registered

registerBinding

public <S,T> void registerBinding(Class<S> sourceClass,
                                  Class<T> targetClass,
                                  Binding<S,T> converter,
                                  Class<? extends Annotation> qualifier)

Register a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding. The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

registerBinding in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (owning) class

targetClass - The target (foreign) class

converter - The binding to be registered

qualifier - The qualifier for which the binding must be registered

registerBinding

public <S,T> void registerBinding(ConverterKey<S,T> key,
                                  Binding<S,T> converter)

Register a Binding with the given source and target class. A binding unifies a marshaller and an unmarshaller and both must be available to resolve a binding. The source class is considered the owning class of the binding. The source can be marshalled into the target class. Similarly, the target can be unmarshalled to produce an instance of the source type.

Specified by:

registerBinding in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The binding to be registered

registerUnmarshaller

public <S,T> void registerUnmarshaller(Class<S> sourceClass,
                                       Class<T> targetClass,
                                       FromUnmarshaller<S,T> converter,
                                       Class<? extends Annotation> qualifier)

Register an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerUnmarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The FromUnmarshaller to be registered

qualifier - The qualifier for which the unmarshaller must be registered

registerUnmarshaller

public <S,T> void registerUnmarshaller(ConverterKey<S,T> key,
                                       FromUnmarshaller<S,T> converter)

Register an UnMarshaller with the given source and target class. The unmarshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerUnmarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The FromUnmarshaller to be registered

registerMarshaller

public <S,T> void registerMarshaller(Class<S> sourceClass,
                                     Class<T> targetClass,
                                     ToMarshaller<S,T> converter,
                                     Class<? extends Annotation> qualifier)

Register a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerMarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The ToMarshaller to be registered

qualifier - The qualifier for which the marshaller must be registered

registerMarshaller

public <S,T> void registerMarshaller(ConverterKey<S,T> key,
                                     ToMarshaller<S,T> converter)

Register a Marshaller with the given source and target class. The marshaller is used as follows: Instances of the source can be marshalled into the target class.

Specified by:

registerMarshaller in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The ToMarshaller to be registered

registerConverter

public <S,T> void registerConverter(Class<S> sourceClass,
                                    Class<T> targetClass,
                                    Converter<S,T> converter,
                                    Class<? extends Annotation> qualifier)

Register a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

registerConverter in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

sourceClass - The source (input) class

targetClass - The target (output) class

converter - The Converter to be registered

qualifier - The qualifier for which the converter must be registered

registerConverter

public <S,T> void registerConverter(ConverterKey<S,T> key,
                                    Converter<S,T> converter)

Register a Converter with the given input and output classes. Instances of the input class can be converted into instances of the output class

Specified by:

registerConverter in interface RegisterableBinder

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The Converter to be registered

registerAnnotatedClasses

public void registerAnnotatedClasses(Class<?>... classesToInspect)

Inspect each of the supplied classes, processing any of the annotated methods found

Specified by:

registerAnnotatedClasses in interface RegisterableBinder

getConverterEntries

public Iterable<ConverterKey<?,?>> getConverterEntries()

Return an iterable collection of ConverterKeys, one for each currently registered conversion

Specified by:

getConverterEntries in interface RegisterableBinder

convertFromString

public <T> T convertFromString(Class<T> output,
                               String object)

Convert a String to the given target class

Specified by:

convertFromString in interface StringBinder

Type Parameters:

T - The type of the target class

Parameters:

output - The target class to convert the object to

object - The String to be converted

Returns:

An instance of the target class

convertFromString

public <T> T convertFromString(Class<T> output,
                               String object,
                               Class<? extends Annotation> qualifier)

Convert a String to the given target class

Specified by:

convertFromString in interface StringBinder

Type Parameters:

T - The type of the target class

Parameters:

output - The target class to convert the object to

object - The String to be converted

qualifier - The qualifier for which the binding must be registered

Returns:

An instance of the target class

convertToString

public String convertToString(Object object)

Convert an object to String This method infers the source type for the conversion from the runtime type of object.

Specified by:

convertToString in interface StringBinder

Parameters:

object - The object to be converted

Returns:

A String

convertToString

public String convertToString(Object object,
                              Class<? extends Annotation> qualifier)

Convert an object to String This method infers the source type for the conversion from the runtime type of object.

Specified by:

convertToString in interface StringBinder

Parameters:

object - The object to be converted

qualifier - The qualifier for which the binding must be registered

Returns:

A String

convertToString

public <S> String convertToString(Class<S> input,
                                  Object object)

Convert an object which is an instance of source class to String

Specified by:

convertToString in interface StringBinder

Type Parameters:

S - The type of the input class

Parameters:

input - The class of the object to be converted

object - The object to be converted

Returns:

A String

convertToString

public <S> String convertToString(Class<S> input,
                                  Object object,
                                  Class<? extends Annotation> qualifier)

Convert an object which is an instance of source class to String

Specified by:

convertToString in interface StringBinder

Type Parameters:

S - The type of the input class

Parameters:

input - The class of the object to be converted

object - The object to be converted

qualifier - Match the converter with the given qualifier

Returns:

A String