Package org.anchoranalysis.plugin.io.naming.interval

Enum TimeStyle

Object

Enum<TimeStyle>

org.anchoranalysis.plugin.io.naming.interval.TimeStyle

All Implemented Interfaces:

Serializable, Comparable<TimeStyle>, java.lang.constant.Constable

public enum TimeStyle
extends Enum<TimeStyle>

How to style a time in a file-name.

Author:

Owen Feehan

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE_SECONDS	The time is included in the name, but without seconds: hh.mm
INCLUDE_ENTIRELY	The entire time is included in the name: hh.mm.ss
OMIT	The time is omitted from the name.

Method Summary

Modifier and Type	Method	Description
DateTimeFormatter	patternWithDate(DateStyle dateStyle)	Derives a formatter for the particular date AND time-style.
static TimeStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TimeStyle[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INCLUDE_ENTIRELY

public static final TimeStyle INCLUDE_ENTIRELY

The entire time is included in the name: hh.mm.ss

IGNORE_SECONDS

public static final TimeStyle IGNORE_SECONDS

The time is included in the name, but without seconds: hh.mm

OMIT

public static final TimeStyle OMIT

The time is omitted from the name.

Method Details

values

public static TimeStyle[] values()

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

Returns:

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

valueOf

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

patternWithDate

public DateTimeFormatter patternWithDate(DateStyle dateStyle)

Derives a formatter for the particular date AND time-style.

Parameters:

dateStyle - whether to include the date or not