Module is.codion.common.core

Package is.codion.common.item

Interface Item<T>

Type Parameters:

T - the type of the value

public interface Item<T>

A class encapsulating a constant value and a caption representing the value. Items equality is based on their values only. Factory for Item instances.

See Also:

• get()
• getOrThrow()
• item(Object)
• item(Object, String)
• i18n(Object, String, String)

Method Summary

Modifier and Type	Method	Description
String	caption()
@Nullable T	get()
default T	getOrThrow()
static <T> Item<T>	i18n(@Nullable T value, String resourceBundleName, String resourceBundleKey)	Creates a new Item, which gets its caption from a resource bundle.
static <T> Item<T>	item(@Nullable T value)	Returns an Item, with the caption as item.toString() or an empty string in case of a null value
static <T> Item<T>	item(@Nullable T value, String caption)	Creates a new Item.

Method Details

caption

String caption()

Returns:

the caption

get

@Nullable T get()

Returns:

the item value

getOrThrow

default T getOrThrow()

Returns:

the item value

Throws:

NoSuchElementException - if no value is present

item

static <T> Item<T> item(@Nullable T value)

Returns an Item, with the caption as item.toString() or an empty string in case of a null value

Type Parameters:

T - the value type

Parameters:

value - the value, may be null

Returns:

an Item based on the given value

item

static <T> Item<T> item(@Nullable T value,
 String caption)

Creates a new Item.

Type Parameters:

T - the value type

Parameters:

value - the value, may be null

caption - the caption

Returns:

an Item based on the given value and caption

Throws:

NullPointerException - if caption is null

i18n

static <T> Item<T> i18n(@Nullable T value,
 String resourceBundleName,
 String resourceBundleKey)

Creates a new Item, which gets its caption from a resource bundle. Note that the caption is cached, so that changing the Locale after the first time caption() is called will not change the caption.

Type Parameters:

T - the value type

Parameters:

value - the value, may be null

resourceBundleName - the resource bundle name

resourceBundleKey - the resource bundle key for the item caption

Returns:

an Item based on the given value and resource bundle