Package org.openhab.core.io.rest.core.item

Class EnrichedItemDTOMapper

java.lang.Object

org.openhab.core.io.rest.core.item.EnrichedItemDTOMapper

@NonNullByDefault
public class EnrichedItemDTOMapper
extends Object

The EnrichedItemDTOMapper is a utility class to map items into enriched item data transform objects (DTOs).

Author:

Dennis Nobel - Initial contribution, Jochen Hiller - Fix #473630 - handle optional dependency to TransformationHelper

Constructor Summary

Constructors

Constructor	Description
EnrichedItemDTOMapper()

Method Summary

Modifier and Type	Method	Description
static EnrichedItemDTO	map(Item item, boolean drillDown, @Nullable Predicate<Item> itemFilter, @Nullable javax.ws.rs.core.UriBuilder uriBuilder, @Nullable Locale locale, @Nullable ZoneId zoneId)	Maps item into enriched item DTO object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnrichedItemDTOMapper

public EnrichedItemDTOMapper()

Method Details

map

public static EnrichedItemDTO map(Item item,
 boolean drillDown,
 @Nullable Predicate<Item> itemFilter,
 @Nullable javax.ws.rs.core.UriBuilder uriBuilder,
 @Nullable Locale locale,
 @Nullable ZoneId zoneId)

Maps item into enriched item DTO object.

Parameters:

item - the item

drillDown - defines whether the whole tree should be traversed or only direct members are considered

itemFilter - a predicate that filters items while traversing the tree (true means that an item is considered, can be null)

uriBuilder - if present the URI builder contains one template that will be replaced by the specific item name

locale - locale (can be null)

zoneId - time-zone id (can be null)

Returns:

item DTO object