Package org.pepstock.charba.client.options

Interface AnimationCollectionKey

All Superinterfaces:

IsTypedAnimationKey, Key

All Known Subinterfaces:

AnimationPropertyKey

All Known Implementing Classes:

DefaultAnimationCollectionKey, DefaultAnimationPropertyKey

public interface AnimationCollectionKey
extends IsTypedAnimationKey

Represents the collection to set to configure animation.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
static AnimationCollectionKey	checkAndGetIfValid(AnimationCollectionKey collection)	Checks if collection passed as argument is not null and its value is not null as well. If not, throw a IllegalArgumentException, otherwise it returns the argument.
static void	checkIfValid(AnimationCollectionKey collection)	Checks if type passed as argument is not null and its type is not null as well. If not, throw a IllegalArgumentException.
static AnimationCollectionKey	create(String collection, AnimationType type)	Returns a animation collection instance by its string value.
static AnimationCollectionKey	create(String collection, AnimationPropertyKey... properties)	Returns a animation collection instance by its string value.
static boolean	isValid(AnimationCollectionKey collection)	Returns true if type passed as argument is not null and its type is not null as well.
List<AnimationPropertyKey>	properties()	Returns the animation properties related to the collection.

Methods inherited from interface org.pepstock.charba.client.options.IsTypedAnimationKey

type

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

value

Method Detail

create

static AnimationCollectionKey create(String collection,
                                     AnimationType type)

Returns a animation collection instance by its string value.

Parameters:

collection - string value to use

type - type of the properties

Returns:

new collection instance

create

static AnimationCollectionKey create(String collection,
                                     AnimationPropertyKey... properties)

Returns a animation collection instance by its string value.

Parameters:

collection - string value to use

properties - initial collection of properties

Returns:

new collection instance

isValid

static boolean isValid(AnimationCollectionKey collection)

Returns true if type passed as argument is not null and its type is not null as well.

Parameters:

collection - animation collection to be checked

Returns:

true if type passed as argument is not null and its type is not null as well.

checkIfValid

static void checkIfValid(AnimationCollectionKey collection)

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

Parameters:

collection - animation collection to be checked

checkAndGetIfValid

static AnimationCollectionKey checkAndGetIfValid(AnimationCollectionKey collection)

Checks if collection passed as argument is not null and its value is not null as well.
If not, throw a IllegalArgumentException, otherwise it returns the argument.

Parameters:

collection - collection to be checked

Returns:

the same collection passed as argument

properties

List<AnimationPropertyKey> properties()

Returns the animation properties related to the collection.

Returns:

the animation properties related to the collection