org.pepstock.charba.client.options

Interface TransitionKey

All Superinterfaces:

Key

All Known Implementing Classes:

DefaultTransitionKey, StandardAnimationTransition

public interface TransitionKey
extends Key

Represents the update mode (transition) to set to configure animation.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static TransitionKey	checkAndGetIfValid(TransitionKey transition) Checks if mode passed as argument is not null. If not, throw a IllegalArgumentException, otherwise it returns the argument.
static void	checkIfValid(TransitionKey transition) Checks if type passed as argument is not null. If not, throw a IllegalArgumentException.
static TransitionKey	create(String transition) Returns a animation update mode (transition) instance by its string value.
static boolean	isValid(TransitionKey transition) Returns true if type passed as argument is not null.

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

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

Method Detail

create

static TransitionKey create(String transition)

Returns a animation update mode (transition) instance by its string value.

Specified by:

create in interface Key

Parameters:

transition - string value to use

Returns:

new update mode (transition) instance

isValid

static boolean isValid(TransitionKey transition)

Returns true if type passed as argument is not null.

Parameters:

transition - animation update mode (transition) to be checked

Returns:

true if type passed as argument is not null

checkIfValid

static void checkIfValid(TransitionKey transition)

Checks if type passed as argument is not null.
If not, throw a IllegalArgumentException.

Parameters:

transition - animation update mode (transition) to be checked

checkAndGetIfValid

static TransitionKey checkAndGetIfValid(TransitionKey transition)

Checks if mode passed as argument is not null.
If not, throw a IllegalArgumentException, otherwise it returns the argument.

Specified by:

checkAndGetIfValid in interface Key

Parameters:

transition - update mode (transition) to be checked

Returns:

the same update mode (transition) passed as argument