de.vandermeer.skb.categories.kvt

Interface IsKey<K>

All Superinterfaces:

CategoryHas, CategoryIs, CategoryWithValue, HasDescription

public interface IsKey<K>
extends CategoryIs, CategoryWithValue, HasDescription

Category of objects that represent a key.

Version:

v0.0.4 build 150619 (19-Jun-15) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields inherited from interface de.vandermeer.skb.categories.CategoryWithValue

comparator

Method Summary

Modifier and Type	Method and Description
K	_value() Returns the value of an IS category.
static <K> IsKey<K>	create() Returns a new generic IsKey object with a default preset key (immutable).
static <K> IsKey<K>	create(K key) Returns a new generic IsKey object with a pre-set key and default description (immutable).
static <K> IsKey<K>	create(K key, String description) Returns a new generic IsKey object with a preset key (immutable).
default K	key() Returns the key

Methods inherited from interface de.vandermeer.skb.categories.HasDescription

getDescription

Methods inherited from interface de.vandermeer.skb.categories.CategoryWithValue

CAT_TO_VALUE, CAT_TO_VALUESTRING, GET_VALUE, GET_VALUESTRING, toLog

Method Detail

key

default K key()

Returns the key

Returns:

key

_value

K _value()

Description copied from interface: CategoryWithValue

Returns the value of an IS category.

Specified by:

_value in interface CategoryWithValue

Returns:

value of an IS category

create

static <K> IsKey<K> create(K key,
                           String description)

Returns a new generic IsKey object with a preset key (immutable).

Type Parameters:

K - type of the key value

Parameters:

key - the object's key

description - a description for the new key

Returns:

new IsKey object with a set key

create

static <K> IsKey<K> create(K key)

Returns a new generic IsKey object with a pre-set key and default description (immutable).

Type Parameters:

K - type of the key value

Parameters:

key - the object's key

Returns:

new IsKey object with a set key

create

static <K> IsKey<K> create()

Returns a new generic IsKey object with a default preset key (immutable).

Type Parameters:

K - type of the key value

Returns:

new IsKey object with a default key