Module simpa.acc

Package simpa.acc.api

Enum Class BpmPlane

java.lang.Object

java.lang.Enum<BpmPlane>

simpa.acc.api.BpmPlane

All Implemented Interfaces:

Serializable, Comparable<BpmPlane>, Constable

public enum BpmPlane
extends Enum<BpmPlane>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
H	Horizontal plane
HV	Combined horizontal and vertical plane
V	Vertical plane

Method Summary

Modifier and Type	Method	Description
boolean	includesHorizontal()
boolean	includesVertical()
static BpmPlane	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BpmPlane[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

H

public static final BpmPlane H

Horizontal plane

V

public static final BpmPlane V

Vertical plane

HV

public static final BpmPlane HV

Combined horizontal and vertical plane

Method Details

values

public static BpmPlane[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BpmPlane valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

includesHorizontal

public boolean includesHorizontal()

includesVertical

public boolean includesVertical()