com.hcl.domino.data

Interface ValueConverter<OBJ>

Type Parameters:

OBJ - type of object containing the data

All Known Subinterfaces:

CollectionEntryValueConverter, DocumentValueConverter, IndexedValueConverter<OBJ>

public interface ValueConverter<OBJ>

Generic value converter interface

Author:

Karsten Lehmann

Method Summary

Modifier and Type	Method and Description
default int	getPriority() Determines the relative priority of this converter compared to other converters of the same type.
<T> T	getValue(OBJ obj, String itemName, Class<T> valueType, T defaultValue) Implement this method to return the converted value type. Will only be invoked if supportsRead(Class) returns true.
<T> List<T>	getValueAsList(OBJ obj, String itemName, Class<T> valueType, List<T> defaultValue) Implement this method to return a list of the converted value type. Will only be invoked if supportsRead(Class) returns true.
<T> void	setValue(OBJ obj, String itemName, T newValue) Implement this method to write a value to the object
boolean	supportsRead(Class<?> valueType) Return true here for all value types that the implementation class supports to read object data.
boolean	supportsWrite(Class<?> valueType, Object value) Return true here for all value types that the implementation class supports to write object data.

Method Detail

supportsRead

boolean supportsRead(Class<?> valueType)

Return true here for all value types that the implementation class supports to read object data.

Parameters:

valueType - requested return value type

Returns:

true if supported type

supportsWrite

boolean supportsWrite(Class<?> valueType,
                      Object value)

Return true here for all value types that the implementation class supports to write object data.

Parameters:

valueType - requested return value type

value - the requested value to write (may be null)

Returns:

true if supported type

getValue

<T> T getValue(OBJ obj,
               String itemName,
               Class<T> valueType,
               T defaultValue)

Implement this method to return the converted value type.
Will only be invoked if supportsRead(Class) returns true.

Type Parameters:

T - value type

Parameters:

obj - object

itemName - item to read

valueType - requested return value type

defaultValue - default value to return if object property is not set

Returns:

return value or null

getValueAsList

<T> List<T> getValueAsList(OBJ obj,
                           String itemName,
                           Class<T> valueType,
                           List<T> defaultValue)

Implement this method to return a list of the converted value type.
Will only be invoked if supportsRead(Class) returns true.

Type Parameters:

T - value type

Parameters:

obj - object

itemName - item to read

valueType - requested return value type

defaultValue - default value to return if object property is not set

Returns:

return value or null

setValue

<T> void setValue(OBJ obj,
                  String itemName,
                  T newValue)

Implement this method to write a value to the object

Type Parameters:

T - value type

Parameters:

obj - object

itemName - name of item to write

newValue - new value

getPriority

default int getPriority()

Determines the relative priority of this converter compared to other converters of the same type.

The default value is 0 and higher values take precedence.

Returns:

the relative priority value of this converter