Package org.springframework.data.convert

Interface ValueConversionContext<P extends PersistentProperty<P>>

public interface ValueConversionContext<P extends PersistentProperty<P>>

The ValueConversionContext provides access to the store-specific PersistentProperty and allows to call the store-default conversion through the read/write methods.

Store implementations should provide their own flavor of ValueConversionContext enhancing the existing API, implementing delegates for read(Object, TypeInformation), write(Object, TypeInformation).

Author:

Christoph Strobl, Oliver Drotbohm

See Also:

• PersistentProperty

Method Summary

Modifier and Type	Method	Description
P	getProperty()	Return the PersistentProperty to be handled.
default Object	read(Object value)	Reads the value as an instance of the property type.
default <T> T	read(Object value, Class<T> target)	Reads the value as an instance of type.
default <T> T	read(Object value, TypeInformation<T> target)	Reads the value as an instance of type.
default Object	write(Object value)	Write the value as an instance of the property type.
default <T> T	write(Object value, Class<T> target)	Write the value as an instance of type.
default <T> T	write(Object value, TypeInformation<T> target)	Write the value as an instance of type.

Method Details

getProperty

P getProperty()

Return the PersistentProperty to be handled.

Returns:

will never be null.

See Also:

• PersistentProperty

write

@Nullable
default Object write(@Nullable
 Object value)

Write the value as an instance of the property type.

Parameters:

value - value to write; can be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of the property type.

See Also:

• PersistentProperty.getTypeInformation()
• write(Object, TypeInformation)

write

@Nullable
default <T> T write(@Nullable
 Object value,
 Class<T> target)

Write the value as an instance of type.

Parameters:

value - value to write; can be null.

target - type of value to be written; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of type.

See Also:

• write(Object, TypeInformation)
• TypeInformation

write

@Nullable
default <T> T write(@Nullable
 Object value,
 TypeInformation<T> target)

Write the value as an instance of type.

Parameters:

value - value to write; can be null.

target - type of value to be written; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be written as an instance of type.

See Also:

• TypeInformation

read

@Nullable
default Object read(@Nullable
 Object value)

Reads the value as an instance of the property type.

Parameters:

value - value to be read; can be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of the property type.

See Also:

• PersistentProperty.getTypeInformation()
• read(Object, TypeInformation)

read

@Nullable
default <T> T read(@Nullable
 Object value,
 Class<T> target)

Reads the value as an instance of type.

Parameters:

value - value to be read; can be null.

target - type of value to be read; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of type.

See Also:

• read(Object, TypeInformation)
• TypeInformation

read

@Nullable
default <T> T read(@Nullable
 Object value,
 TypeInformation<T> target)

Reads the value as an instance of type.

Parameters:

value - value to be read; can be null.

target - type of value to be read; must not be null.

Returns:

can be null.

Throws:

IllegalStateException - if value cannot be read as an instance of type.

See Also:

• TypeInformation