com.hcl.domino.data

Interface TypedAccess

All Known Subinterfaces:

AutoCloseableDocument, CollectionEntry, DeletionStub, Document

public interface TypedAccess

Common interface to read Domino data with a specific type

Method Summary

Modifier and Type	Method and Description
<T> T	get(String itemName, Class<T> valueType, T defaultValue) Returns an item value converted to the specified data type. We currently support the following value types out of the box: String Integer Long Double DominoDateTime LocalDate LocalTime OffsetDateTime TemporalAccessor (returned as DominoDateTime) Additional value types are supported by implementing and registering DocumentValueConverter as Java services.
<T> List<T>	getAsList(String itemName, Class<T> valueType, List<T> defaultValue) Returns a list of item values converted to the specified data type. We currently support the following value types out of the box: String Integer Long Double DominoDateTime LocalDate LocalTime OffsetDateTime TemporalAccessor (returned as DominoDateTime) Additional value types are supported by implementing and registering DocumentValueConverter as Java services.
List<String>	getItemNames() Returns the names of all available items
boolean	hasItem(String itemName) Checks if an item is available

Method Detail

hasItem

boolean hasItem(String itemName)

Checks if an item is available

Parameters:

itemName - item name

Returns:

true if available

getItemNames

List<String> getItemNames()

Returns the names of all available items

Returns:

names

get

<T> T get(String itemName,
          Class<T> valueType,
          T defaultValue)

Returns an item value converted to the specified data type.

We currently support the following value types out of the box:

• String
• Integer
• Long
• Double
• DominoDateTime
• LocalDate
• LocalTime
• OffsetDateTime
• TemporalAccessor (returned as DominoDateTime)

Additional value types are supported by implementing and registering DocumentValueConverter as Java services.

Type Parameters:

T - type of return value

Parameters:

itemName - item name, case insensitive

valueType - class of return value

defaultValue - default value returned of object does not contain property

Returns:

return value

Throws:

IllegalArgumentException - if the specified value type is unsupported

getAsList

<T> List<T> getAsList(String itemName,
                      Class<T> valueType,
                      List<T> defaultValue)

Returns a list of item values converted to the specified data type.

We currently support the following value types out of the box:

• String
• Integer
• Long
• Double
• DominoDateTime
• LocalDate
• LocalTime
• OffsetDateTime
• TemporalAccessor (returned as DominoDateTime)

Additional value types are supported by implementing and registering DocumentValueConverter as Java services.

Type Parameters:

T - type of return value

Parameters:

itemName - item name, case insensitive

valueType - class of return value

defaultValue - default value returned of object does not contain property

Returns:

value list

Throws:

IllegalArgumentException - if the specified value type is unsupported