Package org.scictrl.mp.orbitcorrect

Enum Class Orientation

java.lang.Object

java.lang.Enum<Orientation>

org.scictrl.mp.orbitcorrect.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, Constable

public enum Orientation
extends Enum<Orientation>

Indicates Horizontal or Vertical orientation of data.

Author:

igor@scictrl.com

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
HORIZONTAL	Horizontal orientation.
VERTICAL	Vertical orientation.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	_H	Constant _H=_HORIZONTAL
static final int	_HORIZONTAL	Constant _HORIZONTAL=0
static final int	_V	Constant _V=_VERTICAL
static final int	_VERTICAL	Constant _VERTICAL=1
static final Orientation	H	Constant H
static final Orientation	V	Constant V

Method Summary

Modifier and Type	Method	Description
String	getShortName()	Short name, H or V.
boolean	isHorizontal()	isHorizontal.
boolean	isVertical()	isVertical.
int	value()	Deprecated. use ordinal()
static Orientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Orientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HORIZONTAL

public static final Orientation HORIZONTAL

Horizontal orientation.

VERTICAL

public static final Orientation VERTICAL

Vertical orientation.

Field Details

_HORIZONTAL

public static final int _HORIZONTAL

Constant _HORIZONTAL=0

See Also:

• Constant Field Values

_VERTICAL

public static final int _VERTICAL

Constant _VERTICAL=1

See Also:

• Constant Field Values

_H

public static final int _H

Constant _H=_HORIZONTAL

See Also:

• Constant Field Values

_V

public static final int _V

Constant _V=_VERTICAL

See Also:

• Constant Field Values

H

public static final Orientation H

Constant H

V

public static final Orientation V

Constant V

Method Details

values

public static Orientation[] 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 Orientation 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

value

@Deprecated
public int value()

Deprecated.

use ordinal()

Same as ordinal.

Returns:

ordinal

isHorizontal

public boolean isHorizontal()

isHorizontal.

Returns:

a boolean

isVertical

public boolean isVertical()

isVertical.

Returns:

a boolean

getShortName

public String getShortName()

Short name, H or V.

Returns:

a short name, H or V