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

Enum Class DateStyle

Object

Enum<DateStyle>

DateStyle

All Implemented Interfaces:

Serializable, Comparable<DateStyle>, Constable

public enum DateStyle
extends Enum<DateStyle>

How to style a date 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_YEAR	The date is included in the name, but without the year: mmm-dd
INCLUDE_ENTIRELY	The entire date is included in the name: yyyy-mm-dd
OMIT	The date is omitted from the name.

Method Summary

Modifier and Type	Method	Description
DateTimeFormatter	formatter()	Derives a formatter for the particular date-style.
String	pattern()	Derives a pattern for the formatter for the particular date-style.
static DateStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DateStyle[]	values()	Returns an array containing the constants of this enum class, 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 DateStyle INCLUDE_ENTIRELY

The entire date is included in the name: yyyy-mm-dd

IGNORE_YEAR

public static final DateStyle IGNORE_YEAR

The date is included in the name, but without the year: mmm-dd

OMIT

public static final DateStyle OMIT

The date is omitted from the name.

Method Details

values

public static DateStyle[] values()

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

Returns:

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

valueOf

public static DateStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

formatter

public DateTimeFormatter formatter()

Derives a formatter for the particular date-style.

pattern

public String pattern()

Derives a pattern for the formatter for the particular date-style.