org.jadira.bindings.core.binder

Interface RegisterableBinder

All Known Implementing Classes:

BasicBinder, BinderExtension

public interface RegisterableBinder

Method Summary

Modifier and Type	Method and Description
Iterable<ConverterKey<?,?>>	getConverterEntries() Return an iterable collection of ConverterKeys, one for each currently registered conversion
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.

Method Detail

registerConfiguration

void registerConfiguration(URL nextLocation)

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

Parameters:

nextLocation - The URL to register

registerBinding

<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.

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The binding to be registered

registerUnmarshaller

<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.

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The FromUnmarshaller to be registered

registerMarshaller

<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.

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The ToMarshaller to be registered

registerConverter

<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

Type Parameters:

S - Source type

T - Target type

Parameters:

key - The converter key

converter - The Converter to be registered

registerBinding

<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.

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

<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.

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

<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.

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

<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

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

<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.

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

registerUnmarshaller

<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.

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

registerMarshaller

<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.

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

registerConverter

<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

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

registerAnnotatedClasses

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

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

Parameters:

classesToInspect -

getConverterEntries

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

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