Package org.apache.tamaya.spi

Class ConversionContext

java.lang.Object

org.apache.tamaya.spi.ConversionContext

public class ConversionContext
extends Object

A conversion context containing all the required values for implementing conversion. Use the included #Builder for creating new instances of. This class is thread-safe to use. Adding supported formats is synchronized.

See Also:

PropertyConverter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConversionContext.Builder	Builder to create new instances of ConversionContext.

Field Summary

Fields

Modifier and Type	Field	Description
static ConversionContext	EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConversionContext(ConversionContext.Builder builder)	Private constructor used from builder.

Method Summary

Modifier and Type	Method	Description
void	addSupportedFormats(Class<?> converterType, String... formatDescriptors)	Allows to addPropertyValue information on the supported/tried formats, which can be shown to the user, especially when conversion failed.
AnnotatedElement	getAnnotatedElement()	Get the annotated element, if conversion is performed using injection mechanisms.
Configuration	getConfiguration()	Get the configuration, which is targeted.
ConfigurationContext	getConfigurationContext()	Deprecated. Use getConfiguration() and Configuration.getContext().
String	getKey()	Get the key accessed.
Map<String,String>	getMeta()	Evaluate the metadata for the current target key from the given values.
List<String>	getSupportedFormats()	Get the supported/tried formats in precedence order.
TypeLiteral<?>	getTargetType()	Get the target type required.
List<PropertyValue>	getValues()	Get the correspnoding underlying property values matching the given key, in order of significance (most significant last).
ConversionContext.Builder	toBuilder()	Creates a builder based on this instance.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ConversionContext EMPTY

Constructor Detail

ConversionContext

protected ConversionContext(ConversionContext.Builder builder)

Private constructor used from builder.

Parameters:

builder - the builder, not null.

Method Detail

getKey

public String getKey()

Get the key accessed. This information is very useful to evaluate additional metadata needed to determine/ control further aspects of the conversion.

Returns:

the key. This may be null in case where a default value has to be converted and no unique underlying key/value configuration is present.

getValues

public List<PropertyValue> getValues()

Get the correspnoding underlying property values matching the given key, in order of significance (most significant last).

Returns:

the underlying values evaluated, never null.

getTargetType

public TypeLiteral<?> getTargetType()

Get the target type required.

Returns:

the target type required.

getAnnotatedElement

public AnnotatedElement getAnnotatedElement()

Get the annotated element, if conversion is performed using injection mechanisms.

Returns:

the annotated element, or null.

getConfiguration

public Configuration getConfiguration()

Get the configuration, which is targeted.

Returns:

the configuration instance, or null.

getMeta

public Map<String,String> getMeta()

Evaluate the metadata for the current target key from the given values. Later values hereby are more significant.

Returns:

the evaluated meta data mapProperties.

addSupportedFormats

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

Allows to addPropertyValue information on the supported/tried formats, which can be shown to the user, especially when conversion failed. Adding of formats is synchronized, all formats are added in order to the overall createList. This means formats should be passed in order of precedence.

Parameters:

converterType - the converters, which implements the formats provided.

formatDescriptors - the format descriptions in a human readable form, e.g. as regular expressions.

getSupportedFormats

public List<String> getSupportedFormats()

Get the supported/tried formats in precedence order. The contents of this method depends on the PropertyConverter instances involved in a conversion.

Returns:

the supported/tried formats, never null.

toBuilder

public ConversionContext.Builder toBuilder()

Creates a builder based on this instance.

toString

public String toString()

Overrides:

toString in class Object

getConfigurationContext

@Deprecated
public ConfigurationContext getConfigurationContext()

Deprecated. Use getConfiguration() and Configuration.getContext().

Get the current configuration context.

Returns:

the current configuration context.