com.hcl.domino.data

Interface IndexedValueConverter<OBJ>

Type Parameters:

OBJ - type of object containing the data

All Superinterfaces:

ValueConverter<OBJ>

All Known Subinterfaces:

CollectionEntryValueConverter

public interface IndexedValueConverter<OBJ>
extends ValueConverter<OBJ>

This subinterface of ValueConverter provides access to indexed data from a source.

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
<T> T	getValue(OBJ obj, int index, Class<T> valueType, T defaultValue) Implement this method to return the converted value type. Will only be invoked if ValueConverter.supportsRead(Class) returns true.
<T> List<T>	getValueAsList(OBJ obj, int index, Class<T> valueType, List<T> defaultValue) Implement this method to return a list of the converted value type. Will only be invoked if ValueConverter.supportsRead(Class) returns true.
<T> void	setValue(OBJ obj, int index, T newValue) Implement this method to write a value to the object

Methods inherited from interface com.hcl.domino.data.ValueConverter

getPriority, getValue, getValueAsList, setValue, supportsRead, supportsWrite

Method Detail

getValue

<T> T getValue(OBJ obj,
               int index,
               Class<T> valueType,
               T defaultValue)

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

Type Parameters:

T - value type

Parameters:

obj - object

index - the index of the 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,
                           int index,
                           Class<T> valueType,
                           List<T> defaultValue)

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

Type Parameters:

T - value type

Parameters:

obj - object

index - the index of the 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,
                  int index,
                  T newValue)

Implement this method to write a value to the object

Type Parameters:

T - value type

Parameters:

obj - object

index - the index of the item to write

newValue - new value