Package jadex.bridge.sensor.unit

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

jadex.bridge.sensor.unit.TimeUnit

All Implemented Interfaces:

IConvertableUnit<java.lang.Long>, IPrettyPrintUnit<java.lang.Long>, java.io.Serializable, java.lang.Comparable<TimeUnit>

public enum TimeUnit
extends java.lang.Enum<TimeUnit>
implements IConvertableUnit<java.lang.Long>, IPrettyPrintUnit<java.lang.Long>

The time unit.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAYS
HOURS
MILLIS
MINS
SECS

Method Summary

Modifier and Type	Method	Description
java.lang.Long	convert(java.lang.Long value)	Convert to a known unit.
java.lang.String	prettyPrint(java.lang.Long value)	Pretty print a value according to the underlying unit to a string.
static TimeUnit	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TimeUnit[]	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

MILLIS

public static final TimeUnit MILLIS

SECS

public static final TimeUnit SECS

MINS

public static final TimeUnit MINS

HOURS

public static final TimeUnit HOURS

DAYS

public static final TimeUnit DAYS

Method Detail

values

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

Returns:

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

valueOf

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

convert

public java.lang.Long convert(java.lang.Long value)

Convert to a known unit.

Specified by:

convert in interface IConvertableUnit<java.lang.Long>

prettyPrint

public java.lang.String prettyPrint(java.lang.Long value)

Pretty print a value according to the underlying unit to a string.

Specified by:

prettyPrint in interface IPrettyPrintUnit<java.lang.Long>

Parameters:

value - The value.

Returns:

The pretty printed string.