Package org.cyclos.model.system.languages

Enum TimeFormat

java.lang.Object

java.lang.Enum<TimeFormat>

org.cyclos.model.system.languages.TimeFormat

All Implemented Interfaces:

Serializable, Comparable<TimeFormat>, HasMessageKey

public enum TimeFormat
extends Enum<TimeFormat>
implements HasMessageKey

Possible formats for times

Enum Constant Summary

Enum Constants

Enum Constant	Description
H12
H24

Method Summary

Modifier and Type	Method	Description
String	format(DateTime dateTime)
static String	format(DateTime dateTime, String pattern)
MessageKey	getMessageKey()
String	getPattern()
static TimeFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TimeFormat[]	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

H24

public static final TimeFormat H24

H12

public static final TimeFormat H12

Method Detail

values

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

Returns:

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

valueOf

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

format

public static String format(DateTime dateTime,
                            String pattern)

format

public String format(DateTime dateTime)

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

getPattern

public String getPattern()