net.obvj.agents.util

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

net.obvj.agents.util.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

Enumerates the supported time units for Timer agents execution.

Author:

oswaldo.bapvic.jr

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOURS Time unit representing sixty minutes
MINUTES Time unit representing sixty second
SECONDS Time unit representing one second

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUnit	DEFAULT The default time unit

Method Summary

Modifier and Type	Method and Description
long	convert(long amount, TimeUnit sourceTimeUnit) Converts the given time duration from a source Time Unit to this Time Unit.
static TimeUnit	findByIdentifier(String identifier) Returns a TimeUnit that is identifiable by the given string.
int	getCalendarConstant() Returns the Calendar constant associated with this Time Unit.
boolean	isIdentifiableBy(String identifier) Checks a given string against a list of known identifiers for a TimeUnit, returning true if a match is found.
long	toMillis(long amount) Converts the given amount into milliseconds.
String	toString() Returns a string representation of this TimeUnit.
static TimeUnit	valueOf(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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SECONDS

public static final TimeUnit SECONDS

Time unit representing one second

MINUTES

public static final TimeUnit MINUTES

Time unit representing sixty second

HOURS

public static final TimeUnit HOURS

Time unit representing sixty minutes

Field Detail

DEFAULT

public static final TimeUnit DEFAULT

The default time unit

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(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

findByIdentifier

public static TimeUnit findByIdentifier(String identifier)

Returns a TimeUnit that is identifiable by the given string.

For example, all of the following strings match to SECONDS:

• s, S
• second, SECOND
• seconds, SECONDS

Parameters:

identifier - a string that identified a Time Unit

Returns:

a TimeUnit, not null

Throws:

IllegalArgumentException - if no time unit matches the given identifier

isIdentifiableBy

public boolean isIdentifiableBy(String identifier)

Checks a given string against a list of known identifiers for a TimeUnit, returning true if a match is found.

Parameters:

identifier - the identifier to be checked

Returns:

true if this TimeUnit is identifiable by the given identifier; false, otherwise.

getCalendarConstant

public int getCalendarConstant()

Returns the Calendar constant associated with this Time Unit.

Returns:

the Calendar constant

toString

public String toString()

Returns a string representation of this TimeUnit.

Overrides:

toString in class Enum<TimeUnit>

Returns:

the string representation of this object

toMillis

public long toMillis(long amount)

Converts the given amount into milliseconds.

Parameters:

amount - the amount to be converted

Returns:

the amount converted into milliseconds

convert

public long convert(long amount,
                    TimeUnit sourceTimeUnit)

Converts the given time duration from a source Time Unit to this Time Unit.

Parameters:

amount - the time duration amount to be converted

sourceTimeUnit - the time unit of the duration parameter

Returns:

the converted amount

Since:

2.0