org.bukkit

Enum Rotation

java.lang.Object

java.lang.Enum<Rotation>

org.bukkit.Rotation

All Implemented Interfaces:

Serializable, Comparable<Rotation>

public enum Rotation
extends Enum<Rotation>

An enum to specify a rotation based orientation, like that on a clock.

It represents how something is viewed, as opposed to cardinal directions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOCKWISE Rotated clockwise by 90 degrees
COUNTER_CLOCKWISE Rotated counter-clockwise by 90 degrees
FLIPPED Flipped upside-down, a 180 degree rotation
NONE No rotation

Method Summary

Methods

Modifier and Type	Method and Description
Rotation	rotateClockwise() Rotate clockwise by 90 degrees.
Rotation	rotateCounterClockwise() Rotate counter-clockwise by 90 degrees.
static Rotation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Rotation[]	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

NONE

public static final Rotation NONE

No rotation

CLOCKWISE

public static final Rotation CLOCKWISE

Rotated clockwise by 90 degrees

FLIPPED

public static final Rotation FLIPPED

Flipped upside-down, a 180 degree rotation

COUNTER_CLOCKWISE

public static final Rotation COUNTER_CLOCKWISE

Rotated counter-clockwise by 90 degrees

Method Detail

values

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

Returns:

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

valueOf

public static Rotation 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

rotateClockwise

public Rotation rotateClockwise()

Rotate clockwise by 90 degrees.

Returns:

the relative rotation

rotateCounterClockwise

public Rotation rotateCounterClockwise()

Rotate counter-clockwise by 90 degrees.

Returns:

the relative rotation