Package adams.core

Enum SecondFormat.Unit

java.lang.Object

java.lang.Enum<SecondFormat.Unit>

adams.core.SecondFormat.Unit

All Implemented Interfaces:

Serializable, Comparable<SecondFormat.Unit>

Enclosing class:

SecondFormat

public static enum SecondFormat.Unit
extends Enum<SecondFormat.Unit>

The available units.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAYS
HOURS
MINUTES
SECONDS
WEEKS

Method Summary

Modifier and Type	Method	Description
long	getFactor()	Returns the factor.
String	getUnit()	Returns the unit string.
static SecondFormat.Unit	parse(String s)	Parses the given string (u|m|S|M|H|D|W) and returns the corresponding unit.
static SecondFormat.Unit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SecondFormat.Unit[]	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

SECONDS

public static final SecondFormat.Unit SECONDS

MINUTES

public static final SecondFormat.Unit MINUTES

HOURS

public static final SecondFormat.Unit HOURS

DAYS

public static final SecondFormat.Unit DAYS

WEEKS

public static final SecondFormat.Unit WEEKS

Method Detail

values

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

Returns:

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

valueOf

public static SecondFormat.Unit 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

getFactor

public long getFactor()

Returns the factor.

Returns:

the factor

getUnit

public String getUnit()

Returns the unit string.

Returns:

the unit string

parse

public static SecondFormat.Unit parse(String s)

Parses the given string (u|m|S|M|H|D|W) and returns the corresponding unit.

Parameters:

s - the string to parse

Returns:

the unit, null if invalid string