org.jmol.constant

Enum EnumAxesMode

java.lang.Object

java.lang.Enum<EnumAxesMode>

org.jmol.constant.EnumAxesMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumAxesMode>

public enum EnumAxesMode
extends java.lang.Enum<EnumAxesMode>

Enum for axes mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUNDBOX
MOLECULAR
UNITCELL

Field Summary

Fields

Modifier and Type	Field and Description
private int	code Code of axes mode.

Method Summary

Methods

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

BOUNDBOX

public static final EnumAxesMode BOUNDBOX

MOLECULAR

public static final EnumAxesMode MOLECULAR

UNITCELL

public static final EnumAxesMode UNITCELL

Field Detail

code

private final int code

Code of axes mode.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

Returns:

Code of axes mode.

getAxesMode

public static EnumAxesMode getAxesMode(int code)

Parameters:

code - Code of axes mode.

Returns:

Axes mode.