Package org.openhab.core.model.script.lib

Class ItemExtensions

java.lang.Object

org.openhab.core.model.script.lib.ItemExtensions

@NonNullByDefault
public class ItemExtensions
extends Object

ItemExtensions provides DSL Item extensions.

Author:

Ravi Nadahar - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ItemExtensions()

Method Summary

Modifier and Type	Method	Description
static ItemChannelLink	addChannelLink(Item item, String channelUid)	Add a new ItemChannelLink between an existing Item and a Channel.
static ItemChannelLink	addChannelLink(Item item, String channelUid, Object... configProperties)	Add a new ItemChannelLink between an existing Item and a Channel.
static ItemChannelLink	addChannelLink(Item item, String channelUid, @Nullable Map<String,@Nullable Object> configProperties)	Add a new ItemChannelLink between an existing Item and a Channel.
static void	addMetadata(Item item, String namespace, String value)	Add metadata to an item.
static void	addMetadata(Item item, String namespace, String value, Object... configProperties)	Add metadata to an item.
static void	addMetadata(Item item, String namespace, String value, @Nullable Map<String,Object> configuration)	Add metadata to an item.
static Set<ChannelUID>	getBoundChannels(Item item)	Get the ChannelUIDs of the channels that are bound to the specified Item.
static Set<Thing>	getBoundThings(Item item)	Get the Things that are bound to the specified Item.
static @Nullable ItemChannelLink	getChannelLink(Item item, @Nullable String channelUid)	Get an existing ItemChannelLink for the specified item and channel.
static @Nullable ItemChannelLink	getChannelLink(Item item, ChannelUID channelUid)	Get an existing ItemChannelLink for the specified item and channel.
static Set<ItemChannelLink>	getChannelLinks(@Nullable Item item)	Get the ItemChannelLinks that are linked to the specified item.
static @Nullable Metadata	getMetadata(Item item, String namespace)	Get item metadata for the specified namespace.
static boolean	isLinked(@Nullable Item item)	Check if the specified item has at least one link.
static boolean	isLinked(@Nullable Item item, @Nullable String channelUid)	Check if the specified item and channel are linked.
static boolean	isLinked(@Nullable Item item, @Nullable ChannelUID channelUid)	Check if the specified item and channel are linked.
static @Nullable ItemChannelLink	removeChannelLink(Item item, @Nullable String channelUid)	Remove a ItemChannelLink between an existing Item and a Channel.
static @Nullable ItemChannelLink	removeChannelLink(Item item, ChannelUID channelUid)	Remove a ItemChannelLink between an existing Item and a Channel.
static int	removeChannelLinks(@Nullable Item item)	Remove all managed links related to the specified item.
static @Nullable Metadata	removeMetadata(Item item, String namespace)	Remove metadata from an item for the specified namespace.
static @Nullable ItemChannelLink	replaceChannelLink(Item item, String channelUid)	Add or replace a ItemChannelLink between an existing Item and a Channel.
static @Nullable ItemChannelLink	replaceChannelLink(Item item, String channelUid, Object... configProperties)	Add or replace a ItemChannelLink between an existing Item and a Channel.
static @Nullable ItemChannelLink	replaceChannelLink(Item item, String channelUid, @Nullable Map<String,@Nullable Object> configProperties)	Add or replace a ItemChannelLink between an existing Item and a Channel.
static @Nullable Metadata	updateMetadata(Item item, String namespace, String value)	Update item metadata for the specified namespace.
static @Nullable Metadata	updateMetadata(Item item, String namespace, String value, Object... configuration)	Update item metadata for the specified namespace.
static @Nullable Metadata	updateMetadata(Item item, String namespace, String value, @Nullable Map<String,Object> configuration)	Update item metadata for the specified namespace.

Methods inherited from class java.lang.Object

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

Constructor Details

ItemExtensions

public ItemExtensions()

Method Details

addMetadata

public static void addMetadata(Item item,
 String namespace,
 String value)

Add metadata to an item.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the metadata value.

Throws:

IllegalArgumentException - If namespace or value is null, if namespace is invalid.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

addMetadata

public static void addMetadata(Item item,
 String namespace,
 String value,
 Object... configProperties)

Add metadata to an item.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the metadata value.

configProperties - the pairs of Strings and Objects that constitutes the configuration.

Throws:

IllegalArgumentException - If namespace or value is null, if namespace is invalid, or if there is an odd number of configProperties, or if any of the keys aren't Strings.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

addMetadata

public static void addMetadata(Item item,
 String namespace,
 String value,
 @Nullable Map<String,Object> configuration)

Add metadata to an item.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the metadata value.

configuration - the Map of configuration properties that make up the configuration.

Throws:

IllegalArgumentException - If namespace or value is null, or if namespace is invalid.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

getMetadata

public static @Nullable Metadata getMetadata(Item item,
 String namespace)

Get item metadata for the specified namespace.

Parameters:

item - the Item.

namespace - the metadata namespace.

Returns:

The matching Metadata or null.

removeMetadata

public static @Nullable Metadata removeMetadata(Item item,
 String namespace)

Remove metadata from an item for the specified namespace.

Parameters:

item - the Item.

namespace - the metadata namespace.

Returns:

The removed Metadata or null if no such metadata existed.

updateMetadata

public static @Nullable Metadata updateMetadata(Item item,
 String namespace,
 String value)

Update item metadata for the specified namespace.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the new metadata value.

Returns:

The old Metadata or null if no previous metadata existed.

Throws:

IllegalArgumentException - If namespace or value is null, or if namespace is invalid.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

updateMetadata

public static @Nullable Metadata updateMetadata(Item item,
 String namespace,
 String value,
 Object... configuration)

Update item metadata for the specified namespace.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the new metadata value.

Returns:

The old Metadata or null if no previous metadata existed.

Throws:

IllegalArgumentException - If namespace or value is null, or is namespace is invalid.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

updateMetadata

public static @Nullable Metadata updateMetadata(Item item,
 String namespace,
 String value,
 @Nullable Map<String,Object> configuration)

Update item metadata for the specified namespace.

Parameters:

item - the Item.

namespace - the metadata namespace.

value - the new metadata value.

configuration - the Map of configuration properties that make up the configuration.

Returns:

The old Metadata or null if no previous metadata existed.

Throws:

IllegalArgumentException - If namespace or value is null, or if namespace is invalid.

UnsupportedOperationException - If the metadata namespace has a reserved MetadataProvider that is not a ManagedProvider.

IllegalStateException - If no ManagedProvider is available.

getChannelLinks

public static Set<ItemChannelLink> getChannelLinks(@Nullable Item item)

Get the ItemChannelLinks that are linked to the specified item.

Parameters:

item - the Item.

Returns:

The Set of ItemChannelLinks.

getBoundChannels

public static Set<ChannelUID> getBoundChannels(Item item)

Get the ChannelUIDs of the channels that are bound to the specified Item.

Parameters:

item - the Item.

Returns:

The Set of ChannelUIDs of the bound channels.

getBoundThings

public static Set<Thing> getBoundThings(Item item)

Get the Things that are bound to the specified Item.

Parameters:

item - the Item.

Returns:

The Set of bound Things.

Throws:

IllegalArgumentException - If item is null.

isLinked

public static boolean isLinked(@Nullable Item item)

Check if the specified item has at least one link.

Parameters:

item - the Item to check.

Returns:

true if a link exists, false otherwise.

isLinked

public static boolean isLinked(@Nullable Item item,
 @Nullable String channelUid)

Check if the specified item and channel are linked.

Parameters:

item - the Item to check.

channelUid - the UID of the channel to check.

Returns:

true if a link exists, false otherwise.

isLinked

public static boolean isLinked(@Nullable Item item,
 @Nullable ChannelUID channelUid)

Check if the specified item and channel are linked.

Parameters:

item - the Item to check.

channelUid - the ChannelUID of the channel to check.

Returns:

true if a link exists, false otherwise.

getChannelLink

public static @Nullable ItemChannelLink getChannelLink(Item item,
 ChannelUID channelUid)

Get an existing ItemChannelLink for the specified item and channel.

Parameters:

item - the Item.

channelUid - the ChannelUID of the channel.

Returns:

The ItemChannelLink or null if none were found.

Throws:

IllegalArgumentException - If item or channelUid is null.

getChannelLink

public static @Nullable ItemChannelLink getChannelLink(Item item,
 @Nullable String channelUid)

Get an existing ItemChannelLink for the specified item and channel.

Parameters:

item - the Item.

channelUid - the UID of the channel.

Returns:

The ItemChannelLink or null if none were found.

Throws:

IllegalArgumentException - If item is null.

addChannelLink

@NonNullByDefault({})
public static ItemChannelLink addChannelLink(Item item,
 String channelUid)

Add a new ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

Returns:

The newly created ItemChannelLink.

Throws:

IllegalArgumentException - If item is null, the ItemChannelLink already exists, or channelUid is invalid.

IllegalStateException - If a ManagedProvider isn't available.

addChannelLink

public static ItemChannelLink addChannelLink(Item item,
 String channelUid,
 Object... configProperties)

Add a new ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

configProperties - the pairs of Strings and Objects that constitutes the configuration properties for the link. Must be in pairs, the first is the key, the second is the value.

Returns:

The newly created ItemChannelLink.

Throws:

IllegalArgumentException - If item is null, channelUid is invalid, the ItemChannelLink already exists, or if there is an odd number of configProperties, or if any of the keys aren't Strings.

IllegalStateException - If a ManagedProvider isn't available.

addChannelLink

public static ItemChannelLink addChannelLink(Item item,
 String channelUid,
 @Nullable Map<String,@Nullable Object> configProperties)

Add a new ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

configProperties - the map of configuration properties for the link.

Returns:

The newly created ItemChannelLink.

Throws:

IllegalArgumentException - If item is null, the ItemChannelLink already exists, or channelUid is invalid.

IllegalStateException - If a ManagedProvider isn't available.

replaceChannelLink

public static @Nullable ItemChannelLink replaceChannelLink(Item item,
 String channelUid)

Add or replace a ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

Returns:

The old ItemChannelLink if one existed, or null.

Throws:

IllegalArgumentException - If item is null or channelUid is invalid.

IllegalStateException - If a ManagedProvider isn't available.

replaceChannelLink

public static @Nullable ItemChannelLink replaceChannelLink(Item item,
 String channelUid,
 Object... configProperties)

Add or replace a ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

configProperties - the pairs of Strings and Objects that constitutes the configuration properties for the link. Must be in pairs, the first is the key, the second is the value.

Returns:

The old ItemChannelLink if one existed, or null.

Throws:

IllegalArgumentException - If item is null, channelUid is invalid, or if there is an odd number of configProperties, or if any of the keys aren't Strings.

IllegalStateException - If a ManagedProvider isn't available.

replaceChannelLink

public static @Nullable ItemChannelLink replaceChannelLink(Item item,
 String channelUid,
 @Nullable Map<String,@Nullable Object> configProperties)

Add or replace a ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item to link.

channelUid - the UID of the channel to link.

configProperties - the map of configuration properties for the link.

Returns:

The old ItemChannelLink if one existed, or null.

Throws:

IllegalArgumentException - If item is null, or channelUid is invalid.

IllegalStateException - If a ManagedProvider isn't available.

removeChannelLink

public static @Nullable ItemChannelLink removeChannelLink(Item item,
 ChannelUID channelUid)

Remove a ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item of the link to remove.

channelUid - the UID of the channel of the link to remove.

Returns:

The removed ItemChannelLink or null if none existed.

Throws:

IllegalArgumentException - If item or channelUid is null.

IllegalStateException - If a ManagedProvider isn't available.

removeChannelLink

public static @Nullable ItemChannelLink removeChannelLink(Item item,
 @Nullable String channelUid)

Remove a ItemChannelLink between an existing Item and a Channel.

Parameters:

item - the Item of the link to remove.

channelUid - the UID of the channel of the link to remove.

Returns:

The removed ItemChannelLink or null if none existed.

Throws:

IllegalArgumentException - If item is null.

IllegalStateException - If a ManagedProvider isn't available.

removeChannelLinks

public static int removeChannelLinks(@Nullable Item item)

Remove all managed links related to the specified item.

Parameters:

item - the Item.

Returns:

The number of removed links.