xyz.thepathfinder.android

Enum CommodityStatus

java.lang.Object

java.lang.Enum<CommodityStatus>

xyz.thepathfinder.android.CommodityStatus

All Implemented Interfaces:

Serializable, Comparable<CommodityStatus>

public enum CommodityStatus
extends Enum<CommodityStatus>

An enum for the possible statuses of a Commodity.

See Also:

Commodity

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED The commodity was cancelled to be picked up.
DROPPED_OFF The commodity was dropped off by a transport.
INACTIVE The commodity is currently not being routed.
PICKED_UP The commodity was picked up by a transport.
WAITING The commodity is waiting to be picked up.

Field Summary

Fields

Modifier and Type	Field and Description
private String	status The string representation of the status.
private static Map<String,CommodityStatus>	statuses Map of the possible statuses.

Method Summary

Modifier and Type	Method and Description
boolean	equals(String status) Checks if this status is the same as the provided status.
static CommodityStatus	getStatus(String status) Changes a String to an CommodityStatus.
String	toString()
static CommodityStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommodityStatus[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INACTIVE

public static final CommodityStatus INACTIVE

The commodity is currently not being routed.

WAITING

public static final CommodityStatus WAITING

The commodity is waiting to be picked up.

PICKED_UP

public static final CommodityStatus PICKED_UP

The commodity was picked up by a transport.

DROPPED_OFF

public static final CommodityStatus DROPPED_OFF

The commodity was dropped off by a transport.

CANCELLED

public static final CommodityStatus CANCELLED

The commodity was cancelled to be picked up.

Field Detail

statuses

private static final Map<String,CommodityStatus> statuses

Map of the possible statuses. It maps String of status to CommodityStatus.

status

private final String status

The string representation of the status.

Method Detail

values

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

Returns:

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

valueOf

public static CommodityStatus valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getStatus

public static CommodityStatus getStatus(String status)

Changes a String to an CommodityStatus. If the status cannot be converted null is returned.

Parameters:

status - represented as a String.

Returns:

CommodityStatus if status could be converted, null otherwise.

equals

public boolean equals(String status)

Checks if this status is the same as the provided status.

Parameters:

status - a string of status

Returns:

true if the status are the same, false otherwise.

toString

public String toString()

Overrides:

toString in class Enum<CommodityStatus>