org.bukkit

Enum FireworkEffect.Type

java.lang.Object

java.lang.Enum<FireworkEffect.Type>

org.bukkit.FireworkEffect.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FireworkEffect.Type>

Enclosing class:

FireworkEffect

public static enum FireworkEffect.Type
extends java.lang.Enum<FireworkEffect.Type>

The type or shape of the effect.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BALL A small ball effect.
BALL_LARGE A large ball effect.
BURST A burst effect.
CREEPER A creeper-face effect.
STAR A star-shaped effect.

Method Summary

Modifier and Type	Method and Description
static FireworkEffect.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FireworkEffect.Type[]	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

BALL

public static final FireworkEffect.Type BALL

A small ball effect.

BALL_LARGE

public static final FireworkEffect.Type BALL_LARGE

A large ball effect.

STAR

public static final FireworkEffect.Type STAR

A star-shaped effect.

BURST

public static final FireworkEffect.Type BURST

A burst effect.

CREEPER

public static final FireworkEffect.Type CREEPER

A creeper-face effect.

Method Detail

values

public static FireworkEffect.Type[] 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 (FireworkEffect.Type c : FireworkEffect.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static FireworkEffect.Type valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null