Package ru.easydonate.easydonate4j.api.v3.data.model.shop

Enum Shop.ParticlesType

java.lang.Object

java.lang.Enum<Shop.ParticlesType>

ru.easydonate.easydonate4j.api.v3.data.model.shop.Shop.ParticlesType

All Implemented Interfaces:

Serializable, Comparable<Shop.ParticlesType>

Enclosing interface:

Shop

public static enum Shop.ParticlesType
extends Enum<Shop.ParticlesType>

The enum that represents all possible and actual particles types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTUMN	Represents the autumn leaf fall particles.
NOTHING	Means that particles is disabled there.
RAIN	Represents the rain particles.
SNOW	Represents the snow particles.
UNKNOWN	Represents an unknown particles type, not known yet.

Method Summary

Modifier and Type	Method	Description
static @NotNull Shop.ParticlesType	getByKey(@Nullable String key)	Get the enum constant by the known particles key (can be null).
static Shop.ParticlesType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Shop.ParticlesType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SNOW

public static final Shop.ParticlesType SNOW

Represents the snow particles.

RAIN

public static final Shop.ParticlesType RAIN

Represents the rain particles.

AUTUMN

public static final Shop.ParticlesType AUTUMN

Represents the autumn leaf fall particles.

NOTHING

public static final Shop.ParticlesType NOTHING

Means that particles is disabled there.

UNKNOWN

public static final Shop.ParticlesType UNKNOWN

Represents an unknown particles type, not known yet.

Method Detail

values

public static Shop.ParticlesType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Shop.ParticlesType c : Shop.ParticlesType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Shop.ParticlesType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getByKey

@NotNull
public static @NotNull Shop.ParticlesType getByKey(@Nullable
                                                   @Nullable String key)

Get the enum constant by the known particles key (can be null).
If the key is null/empty or relevant enum constant with this key will not be found then this method will return UNKNOWN constant as default.

Parameters:

key - the particles key to find an enum constant.

Returns:

The found particles enum constant or UNKNOWN by default.