org.openpnp.model

Enum AreaUnit

java.lang.Object

java.lang.Enum<AreaUnit>

org.openpnp.model.AreaUnit

All Implemented Interfaces:

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

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

Defined units of two dimensional space

Enum Constant Summary

Enum Constants

Enum Constant and Description
SquareCentimeters
SquareFeet
SquareInches
SquareMeters
SquareMicrons
SquareMillimeters
SquareMils

Method Summary

Modifier and Type	Method and Description
static AreaUnit	fromLengthUnit(LengthUnit lengthUnit) Creates an area unit that is equivalent to the square of the given length unit
LengthUnit	getLengthUnit() Gets a length unit, that when squared, is equivalent to this area unit
java.lang.String	getShortName()
java.lang.String	getSingularName()
static AreaUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AreaUnit[]	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

SquareMeters

public static final AreaUnit SquareMeters

SquareCentimeters

public static final AreaUnit SquareCentimeters

SquareMillimeters

public static final AreaUnit SquareMillimeters

SquareFeet

public static final AreaUnit SquareFeet

SquareInches

public static final AreaUnit SquareInches

SquareMils

public static final AreaUnit SquareMils

SquareMicrons

public static final AreaUnit SquareMicrons

Method Detail

values

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

Returns:

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

valueOf

public static AreaUnit 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()

Gets a length unit, that when squared, is equivalent to this area unit

Returns:

the length unit

fromLengthUnit

public static AreaUnit fromLengthUnit(LengthUnit lengthUnit)

Creates an area unit that is equivalent to the square of the given length unit

Parameters:

lengthUnit - - the given length unit

Returns:

the area unit