Interface AnimationCollectionKey
-
- All Superinterfaces:
IsTypedAnimationKey
,Key
- All Known Subinterfaces:
AnimationPropertyKey
- All Known Implementing Classes:
DefaultAnimationCollectionKey
,DefaultAnimationPropertyKey
,StandardAnimationCollection
,StandardAnimationProperty
public interface AnimationCollectionKey extends IsTypedAnimationKey
Represents the collection to set to configure animation.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static AnimationCollectionKey
checkAndGetIfValid(AnimationCollectionKey collection)
Checks if collection passed as argument is notnull
and its value is notnull
as well.
If not, throw aIllegalArgumentException
, otherwise it returns the argument.static void
checkIfValid(AnimationCollectionKey collection)
Checks if type passed as argument is notnull
and its type is notnull
as well.
If not, throw aIllegalArgumentException
.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)
Returnstrue
if type passed as argument is notnull
and its type is notnull
as well.List<AnimationPropertyKey>
properties()
Returns the animation properties related to the collection.-
Methods inherited from interface org.pepstock.charba.client.options.IsTypedAnimationKey
type
-
-
-
-
Method Detail
-
create
static AnimationCollectionKey create(String collection, AnimationType type)
Returns a animation collection instance by its string value.- Parameters:
collection
- string value to usetype
- 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 useproperties
- initial collection of properties- Returns:
- new collection instance
-
isValid
static boolean isValid(AnimationCollectionKey collection)
Returnstrue
if type passed as argument is notnull
and its type is notnull
as well.- Parameters:
collection
- animation collection to be checked- Returns:
true
if type passed as argument is notnull
and its type is notnull
as well.
-
checkIfValid
static void checkIfValid(AnimationCollectionKey collection)
Checks if type passed as argument is notnull
and its type is notnull
as well.
If not, throw aIllegalArgumentException
.- Parameters:
collection
- animation collection to be checked
-
checkAndGetIfValid
static AnimationCollectionKey checkAndGetIfValid(AnimationCollectionKey collection)
Checks if collection passed as argument is notnull
and its value is notnull
as well.
If not, throw aIllegalArgumentException
, 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
-
-