Package com.broadleafcommerce.inventory.domain

Enum Class DistanceType

java.lang.Object

java.lang.Enum<DistanceType>

com.broadleafcommerce.inventory.domain.DistanceType

All Implemented Interfaces:

Serializable, Comparable<DistanceType>, Constable

public enum DistanceType
extends Enum<DistanceType>

Indicates the whether the specified distance to/from an InventoryLocation is in MILES or KILOMETERS.

Author:

Kelly Tisdell (ktisdell)

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
KILOMETERS	Indicates distance is in Kilometers
MILES	Indicates distance is in Miles

Method Summary

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

MILES

public static final DistanceType MILES

Indicates distance is in Miles

KILOMETERS

public static final DistanceType KILOMETERS

Indicates distance is in Kilometers

Method Details

values

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