Package org.kigalisim.lang.operation

Enum Class DisplacementType

java.lang.Object

java.lang.Enum<DisplacementType>

org.kigalisim.lang.operation.DisplacementType

All Implemented Interfaces:

Serializable, Comparable<DisplacementType>, java.lang.constant.Constable

public enum DisplacementType
extends Enum<DisplacementType>

Enum representing the type of displacement for cap and floor operations.

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
BY_UNITS	By units displacement - always convert to units and displace by equipment count.
BY_VOLUME	By volume displacement - always convert to kg and displace by volume.
EQUIVALENT	Equivalent displacement - displaces based on context (volume if last specified as volume, units if units).

Method Summary

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

EQUIVALENT

public static final DisplacementType EQUIVALENT

Equivalent displacement - displaces based on context (volume if last specified as volume, units if units).

BY_VOLUME

public static final DisplacementType BY_VOLUME

By volume displacement - always convert to kg and displace by volume.

BY_UNITS

public static final DisplacementType BY_UNITS

By units displacement - always convert to units and displace by equipment count.

Method Details

values

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