org.hibernate.ogm.util.configurationreader.spi

Interface PropertyReaderContext<T>

Type Parameters:

T - the expected type of the property

All Known Subinterfaces:

ClassPropertyReaderContext<T>

All Known Implementing Classes:

DefaultClassPropertyReaderContext, SimplePropertyReaderContext

public interface PropertyReaderContext<T>

A context for retrieving the value of a given property.

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method and Description
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.
PropertyReaderContext<T>	withValidator(PropertyValidator<T> validator) Adds a validator used to validate the value of the given property.

Method Detail

withDefault

PropertyReaderContext<T> withDefault(T defaultValue)

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

Parameters:

defaultValue - the default value used when non is specified

Returns:

the property reader context

required

PropertyReaderContext<T> required()

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

Returns:

the property reader context

withValidator

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

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

Parameters:

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

Returns:

the property reader context

instantiate

ClassPropertyReaderContext<T> instantiate()

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

Returns:

the class property reader context

getValue

T getValue()

Returns the value of the specified property.

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

Throws:

HibernateException - If the property is marked as required but is not present or if one of the registered PropertyValidators detects an invalid value