org.opensha.commons.util
Enum DevStatus

java.lang.Object
  java.lang.Enum<DevStatus>
      org.opensha.commons.util.DevStatus

All Implemented Interfaces:

Serializable, Comparable<DevStatus>, Named

public enum DevStatus
extends Enum<DevStatus>
implements Named

Class that may be used to represent different states of development. For example, a particular interface or abstract class may have some implementations that have been vetted and tested and are ready for use in production environments while others are under development, experimental, or deprecated.

Version:

$Id: DevStatus.java 8393 2011-12-01 01:46:25Z kmilner $

Author:

Peter Powers

Enum Constant Summary

DEPRECATED
Status indicating something is deprecated.

DEVELOPMENT
Status indicating something is under development.

ERROR
Status indicating something has a critical error and is disabled until fixed

EXPERIMENTAL
Status indicating something is merely experimental.

PRODUCTION
Status indicating something is production ready.

Method Summary

String	getBuildDirName() This retuns the name of the directory associated with this DevStatus instance.
String	getName() Returns the name of this object
String	toString()
static DevStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static DevStatus[]	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

PRODUCTION

public static final DevStatus PRODUCTION

Status indicating something is production ready.

DEVELOPMENT

public static final DevStatus DEVELOPMENT

Status indicating something is under development.

EXPERIMENTAL

public static final DevStatus EXPERIMENTAL

Status indicating something is merely experimental.

DEPRECATED

public static final DevStatus DEPRECATED

Status indicating something is deprecated.

ERROR

public static final DevStatus ERROR

Status indicating something has a critical error and is disabled until fixed

Method Detail

values

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

Returns:

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

valueOf

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

getBuildDirName

public String getBuildDirName()

This retuns the name of the directory associated with this DevStatus instance. This is used in the directory structure for builds on our server.

Returns:

build dir name

Throws:

UnsupportedOperationException - if not applicable for this DevStatus

getName

public String getName()

Description copied from interface: Named

Returns the name of this object

Specified by:

getName in interface Named

toString

public String toString()

Overrides:

toString in class Enum<DevStatus>