Package org.apache.tamaya.spi

Class ConversionContext.Builder

java.lang.Object

org.apache.tamaya.spi.ConversionContext.Builder

Enclosing class:

ConversionContext

public static final class ConversionContext.Builder
extends Object

Builder to create new instances of ConversionContext.

Constructor Summary

Constructors

Constructor	Description
Builder(String key, TypeLiteral<?> targetType)	Creates a new Builder instance.
Builder(Configuration configuration, String key, TypeLiteral<?> targetType)	Creates a new Builder instance.
Builder(TypeLiteral<?> targetType)	Creates a new Builder instance.

Method Summary

Modifier and Type	Method	Description
ConversionContext.Builder	addSupportedFormats(Class<?> converterType, String... formatDescriptors)	Add the formats provided by a PropertyConverter.
ConversionContext	build()	Builds a new context instance.
ConversionContext.Builder	setAnnotatedElement(AnnotatedElement annotatedElement)	Sets the annotated element, when configuration is injected.
ConversionContext.Builder	setConfiguration(Configuration configuration)	Sets the configuration.
ConversionContext.Builder	setKey(String key)	Sets the key.
ConversionContext.Builder	setTargetType(TypeLiteral targetType)	Sets the target type explicitly.
ConversionContext.Builder	setValues(List<PropertyValue> values)	Sets the underlying values evaluated.
ConversionContext.Builder	setValues(PropertyValue... values)	Sets the underlying values evaluated.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(TypeLiteral<?> targetType)

Creates a new Builder instance.

Parameters:

targetType - the target type

Builder

public Builder(String key,
               TypeLiteral<?> targetType)

Creates a new Builder instance.

Parameters:

key - the requested key, may be null.

targetType - the target type

Builder

public Builder(Configuration configuration,
               String key,
               TypeLiteral<?> targetType)

Creates a new Builder instance.

Parameters:

configuration - the configuration, not null.

key - the requested key, may be null.

targetType - the target type

Method Detail

setKey

public ConversionContext.Builder setKey(String key)

Sets the key.

Parameters:

key - the key, not null.

Returns:

the builder instance, for chaining

setValues

public ConversionContext.Builder setValues(List<PropertyValue> values)

Sets the underlying values evaluated.

Parameters:

values - the values, not null.

Returns:

the builder instance, for chaining

setValues

public ConversionContext.Builder setValues(PropertyValue... values)

Sets the underlying values evaluated.

Parameters:

values - the values, not null.

Returns:

the builder instance, for chaining

setConfiguration

public ConversionContext.Builder setConfiguration(Configuration configuration)

Sets the configuration.

Parameters:

configuration - the configuration, not null

Returns:

the builder instance, for chaining

setAnnotatedElement

public ConversionContext.Builder setAnnotatedElement(AnnotatedElement annotatedElement)

Sets the annotated element, when configuration is injected.

Parameters:

annotatedElement - the annotated element, not null

Returns:

the builder instance, for chaining

setTargetType

public ConversionContext.Builder setTargetType(TypeLiteral targetType)

Sets the target type explicitly. This is required in some rare cases, e.g. injection of Provider instances, where the provider's result type must be produced.

Parameters:

targetType - the

Returns:

the builder for chaining.

addSupportedFormats

public ConversionContext.Builder addSupportedFormats(Class<?> converterType,
                                                     String... formatDescriptors)

Add the formats provided by a PropertyConverter. This method should be called by each converters performing/trying conversion, so the user can be given feedback on the supported formats on failure.

Parameters:

converterType - the converters type, not null.

formatDescriptors - the formats supported in a human readable form, e.g. as regular expressions.

Returns:

the builder instance, for chaining

build

public ConversionContext build()

Builds a new context instance.

Returns:

a new context, never null.

toString

public String toString()

Overrides:

toString in class Object