ch.agent.t2.time

Enum Adjustment

java.lang.Object

java.lang.Enum<Adjustment>

ch.agent.t2.time.Adjustment

All Implemented Interfaces:

Serializable, Comparable<Adjustment>

public enum Adjustment
extends Enum<Adjustment>

Adjustment defines three adjustment modes used when parsing time strings or converting between time domains. Sometimes a time which can be expressed using the methods provided does not correspond to a valid time in the given time domain. For example January 1, 2000 is a Saturday, and cannot be represented in a time domain which excludes weekends. Some methods allow to specify an adjustment mode to manage such situations. There are three possible modes:

1. Adjust downwards (to December 31, 1999 in the example)
2. Adjust upwards (to Monday, January 3, 2000)
3. Do not adjust and produce an error.

Author:

Jean-Paul Vetterli

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Requires downward adjustment.
NONE Forbids any adjustment.
UP Requires upward adjustment.

Method Summary

Modifier and Type	Method and Description
static Adjustment	valueOf(String name) Returns the enum constant of this type with the specified name.
static Adjustment[]	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

DOWN

public static final Adjustment DOWN

Requires downward adjustment.

UP

public static final Adjustment UP

Requires upward adjustment.

NONE

public static final Adjustment NONE

Forbids any adjustment.

Method Detail

values

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

Returns:

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

valueOf

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