org.pepstock.charba.client.labels

Interface LabelId

All Superinterfaces:

Key, PropertyKey

public interface LabelId
extends PropertyKey

Represents the label id of a label configuration object in the LabelsPlugin.ID plugin.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static void	checkIfValid(LabelId id) Checks if id passed as argument is not null and its value is not null as well and could be a valid label configuration object id. If not, throw a IllegalArgumentException.
static LabelId	create(String id) Returns a key instance by its string value.
static boolean	isValid(LabelId id) Returns true if id passed as argument is not null and its value is not null as well and could be a valid label configuration object id.

Methods inherited from interface org.pepstock.charba.client.commons.PropertyKey

checkIfValid, checkIfValid, isValid, isValid

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid, value

Method Detail

create

static LabelId create(String id)

Returns a key instance by its string value.

Specified by:

create in interface Key

Parameters:

id - string value to use

Returns:

new label configuration object id instance

isValid

static boolean isValid(LabelId id)

Returns true if id passed as argument is not null and its value is not null as well and could be a valid label configuration object id.

Parameters:

id - label configuration object id to be checked

Returns:

true if id passed as argument is not null and its value is not null as well and could be a valid label configuration object id.

checkIfValid

static void checkIfValid(LabelId id)

Checks if id passed as argument is not null and its value is not null as well and could be a valid label configuration object id.
If not, throw a IllegalArgumentException.

Parameters:

id - label configuration object id to be checked