org.openpnp.model

Enum VolumeUnit

java.lang.Object

java.lang.Enum<VolumeUnit>

org.openpnp.model.VolumeUnit

All Implemented Interfaces:

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

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

Defined units of three dimensional space

Enum Constant Summary

Enum Constants

Enum Constant and Description
CubicCentimeters
CubicFeet
CubicInches
CubicMeters
CubicMicrons
CubicMillimeters
CubicMils
FemtoLiters
MicroLiters
MilliLiters

Method Summary

Modifier and Type	Method and Description
static VolumeUnit	fromLengthUnit(LengthUnit lengthUnit) Creates a preferred volume unit equivalent to the cube of the given length unit
static VolumeUnit	fromLengthUnit(LengthUnit lengthUnit, boolean preferredUnit) Creates a volume unit equivalent to the cube of the given length unit
LengthUnit	getLengthUnit() Creates a length unit, that when cubed, is equivalent to this volume unit
java.lang.String	getShortName()
java.lang.String	getSingularName()
static VolumeUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VolumeUnit[]	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

CubicMeters

public static final VolumeUnit CubicMeters

CubicCentimeters

public static final VolumeUnit CubicCentimeters

MilliLiters

public static final VolumeUnit MilliLiters

CubicMillimeters

public static final VolumeUnit CubicMillimeters

MicroLiters

public static final VolumeUnit MicroLiters

CubicFeet

public static final VolumeUnit CubicFeet

CubicInches

public static final VolumeUnit CubicInches

CubicMils

public static final VolumeUnit CubicMils

CubicMicrons

public static final VolumeUnit CubicMicrons

FemtoLiters

public static final VolumeUnit FemtoLiters

Method Detail

values

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

Returns:

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

valueOf

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

getShortName

public java.lang.String getShortName()

getSingularName

public java.lang.String getSingularName()

getLengthUnit

public LengthUnit getLengthUnit()

Creates a length unit, that when cubed, is equivalent to this volume unit

Returns:

the length unit

fromLengthUnit

public static VolumeUnit fromLengthUnit(LengthUnit lengthUnit)

Creates a preferred volume unit equivalent to the cube of the given length unit

Parameters:

lengthUnit - - the given length unit

Returns:

the volume unit

fromLengthUnit

public static VolumeUnit fromLengthUnit(LengthUnit lengthUnit,
                                        boolean preferredUnit)

Creates a volume unit equivalent to the cube of the given length unit

Parameters:

lengthUnit - - the given length unit

preferredUnit - - flag to indicate whether the preferred or non-preferred unit should be returned (preferred unit is returned when set to true)

Returns:

the volume unit