org.hibernate.ogm.util.configurationreader.impl

Class DefaultClassPropertyReaderContext<T>

java.lang.Object

org.hibernate.ogm.util.configurationreader.impl.DefaultClassPropertyReaderContext<T>

Type Parameters:

T - the type of the value to instantiate

All Implemented Interfaces:

ClassPropertyReaderContext<T>, PropertyReaderContext<T>

public class DefaultClassPropertyReaderContext<T>
extends Object
implements ClassPropertyReaderContext<T>

A PropertyReaderContext which allows to retrieve properties by instantiating a given implementation type, e.g. specified as fully-qualified class name or class object.

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method and Description
T	getTypedValue() To be implemented in sub-classes to convert the configured value into an object of the property target type.
T	getValue() Returns the value of the specified property.
ClassPropertyReaderContext<T>	instantiate() Returns a context which allows to specify how the implementation type represented by the given property should be instantiated.
PropertyReaderContext<T>	required() Marks the given property as required.
PropertyReaderContext<T>	withDefault(T defaultValue) Sets a default value in case no value is specified for the given property.
DefaultClassPropertyReaderContext<T>	withDefaultImplementation(Class<? extends T> defaultImplementation) Sets the default implementation type for the property in case no value is found.
DefaultClassPropertyReaderContext<T>	withDefaultImplementation(String defaultImplementationName) Sets the name of default implementation type for the property in case no value is found.
DefaultClassPropertyReaderContext<T>	withInstantiator(Instantiator<T> instantiator) Sets an instantiator to be used to create an instance of the property.
DefaultClassPropertyReaderContext<T>	withShortNameResolver(ShortNameResolver shortNameResolver) Sets a short name resolver to be applied in case the property is given as string
PropertyReaderContext<T>	withValidator(PropertyValidator<T> validator) Adds a validator used to validate the value of the given property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.ogm.util.configurationreader.spi.PropertyReaderContext

getValue, instantiate, required, withDefault, withValidator

Method Detail

withDefaultImplementation

public DefaultClassPropertyReaderContext<T> withDefaultImplementation(Class<? extends T> defaultImplementation)

Description copied from interface: ClassPropertyReaderContext

Sets the default implementation type for the property in case no value is found.

Specified by:

withDefaultImplementation in interface ClassPropertyReaderContext<T>

Parameters:

defaultImplementation - the implementation to use if none is configured

Returns:

the class property reader context

withDefaultImplementation

public DefaultClassPropertyReaderContext<T> withDefaultImplementation(String defaultImplementationName)

Description copied from interface: ClassPropertyReaderContext

Sets the name of default implementation type for the property in case no value is found.

Specified by:

withDefaultImplementation in interface ClassPropertyReaderContext<T>

Parameters:

defaultImplementationName - the implementation to use if none is configured

Returns:

the class property reader context

withInstantiator

public DefaultClassPropertyReaderContext<T> withInstantiator(Instantiator<T> instantiator)

Sets an instantiator to be used to create an instance of the property. Currently not exposed on the SPI as it is only needed within this module. May be promoted to an SPI later on, if required.

Parameters:

instantiator - the Instantiator to use to create the instance of the property

Returns:

an instance of the property

withShortNameResolver

public DefaultClassPropertyReaderContext<T> withShortNameResolver(ShortNameResolver shortNameResolver)

Description copied from interface: ClassPropertyReaderContext

Sets a short name resolver to be applied in case the property is given as string

Specified by:

withShortNameResolver in interface ClassPropertyReaderContext<T>

Parameters:

shortNameResolver - the resolver to use when an implementation short name is provided

Returns:

the class property reader context

getTypedValue

public T getTypedValue()

To be implemented in sub-classes to convert the configured value into an object of the property target type.

Specified by:

getTypedValue in interface ClassPropertyReaderContext<T>

Returns:

the configured property as instance of the given target type; May be null

withDefault

public PropertyReaderContext<T> withDefault(T defaultValue)

Description copied from interface: PropertyReaderContext

Sets a default value in case no value is specified for the given property.

Specified by:

withDefault in interface PropertyReaderContext<T>

Parameters:

defaultValue - the default value used when non is specified

Returns:

the property reader context

required

public PropertyReaderContext<T> required()

Description copied from interface: PropertyReaderContext

Marks the given property as required. In this case an exception will be raised if no value is specified for that property.

Specified by:

required in interface PropertyReaderContext<T>

Returns:

the property reader context

withValidator

public PropertyReaderContext<T> withValidator(PropertyValidator<T> validator)

Description copied from interface: PropertyReaderContext

Adds a validator used to validate the value of the given property. Several validators can be added.

Specified by:

withValidator in interface PropertyReaderContext<T>

Parameters:

validator - the validator to use for the value of the property

Returns:

the property reader context

instantiate

public ClassPropertyReaderContext<T> instantiate()

Description copied from interface: PropertyReaderContext

Returns a context which allows to specify how the implementation type represented by the given property should be instantiated.

Specified by:

instantiate in interface PropertyReaderContext<T>

Returns:

the class property reader context

getValue

public T getValue()

Description copied from interface: PropertyReaderContext

Returns the value of the specified property.

Specified by:

getValue in interface PropertyReaderContext<T>

Returns:

the value of the specified property; May be null in case the property is not present in the given configuration map and no default implementation has been specified