com.github.jknack.handlebars.helper

Enum JodaHelper

java.lang.Object

java.lang.Enum<JodaHelper>

com.github.jknack.handlebars.helper.JodaHelper

All Implemented Interfaces:

Helper<org.joda.time.ReadableInstant>, Serializable, Comparable<JodaHelper>

public enum JodaHelper
extends Enum<JodaHelper>
implements Helper<org.joda.time.ReadableInstant>

Handlebars Helper for JodaTime ReadableInstance objects.

Author:

@mrhanlon https://github.com/mrhanlon

Enum Constant Summary

Enum Constants

Enum Constant and Description
jodaISO A Helper for ISO-formatted ReadableInstant.
jodaPattern A Helper for pattern-formatted ReadableInstance.
jodaStyle A Helper for style-formatted ReadableInstant.

Method Summary

Methods

Modifier and Type	Method and Description
Object	apply(org.joda.time.ReadableInstant time, Options options)
protected abstract CharSequence	safeApply(org.joda.time.ReadableInstant time, Options options) Apply the helper to the context.
static JodaHelper	valueOf(String name) Returns the enum constant of this type with the specified name.
static JodaHelper[]	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

jodaPattern

public static final JodaHelper jodaPattern

A Helper for pattern-formatted ReadableInstance. Pattern usage is as specified in DateTimeFormat. Defaults to M d y, H:m:s z, for example 11 15 1995, 14:32:10 CST.

jodaStyle

public static final JodaHelper jodaStyle

A Helper for style-formatted ReadableInstant. Style usage is as specified in DateTimeFormat. Defaults to MM, for example

jodaISO

public static final JodaHelper jodaISO

A Helper for ISO-formatted ReadableInstant. Usages is detailed in ISODateTimeFormat.

Method Detail

values

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

Returns:

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

valueOf

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

apply

public Object apply(org.joda.time.ReadableInstant time,
           Options options)
             throws IOException

Specified by:

apply in interface Helper<org.joda.time.ReadableInstant>

Throws:

IOException

safeApply

protected abstract CharSequence safeApply(org.joda.time.ReadableInstant time,
                     Options options)

Apply the helper to the context.

Parameters:

time - The JodaTime ReadableInstant.

options - Any formatting options, such as the Pattern, Style, or ISO format.

Returns:

The String result.