org.supercsv.cellprocessor.joda

Class FmtDateTime

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

org.supercsv.cellprocessor.joda.AbstractJodaFormattingProcessor<DateTime>

org.supercsv.cellprocessor.joda.FmtDateTime

All Implemented Interfaces:

CellProcessor

public class FmtDateTime
extends AbstractJodaFormattingProcessor<DateTime>

Converts a Joda DateTime to a String.

For constructors using DateTimeFormatter, refer to the following Joda classes:

• DateTimeFormat - formats by pattern and style
• ISODateTimeFormat - ISO8601 formats
• DateTimeFormatterBuilder - complex formats created via method calls

For constructors using date format Strings, refer to DateTimeFormat for example formats.

Since:

2.3.0

Author:

James Bassett

Field Summary

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Constructor Summary

Constructors

Constructor and Description
FmtDateTime() Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String.
FmtDateTime(CellProcessor next) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String, then calls the next processor in the chain.
FmtDateTime(DateTimeFormatter formatter) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied formatter.
FmtDateTime(DateTimeFormatter formatter, CellProcessor next) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied formatter, then calls the next processor in the chain.
FmtDateTime(String pattern) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the default locale.
FmtDateTime(String pattern, CellProcessor next) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the default locale, then calls the next processor in the chain.
FmtDateTime(String pattern, Locale locale) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the locale.
FmtDateTime(String pattern, Locale locale, CellProcessor next) Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the locale, then calls the next processor in the chain.

Method Summary

Modifier and Type	Method and Description
protected String	format(DateTime jodaType) Formats the Joda type as a String using the default pattern and locale.
protected String	format(DateTime jodaType, DateTimeFormatter formatter) Formats the Joda type as a String using a DateTimeFormatter.
protected String	format(DateTime jodaType, String pattern, Locale locale) Formats the Joda type as a String using the supplied pattern and (optional) locale.

Methods inherited from class org.supercsv.cellprocessor.joda.AbstractJodaFormattingProcessor

execute

Methods inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

toString, validateInputNotNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FmtDateTime

public FmtDateTime()

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String.

FmtDateTime

public FmtDateTime(CellProcessor next)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String, then calls the next processor in the chain.

Parameters:

next - next processor in the chain

Throws:

NullPointerException - if next is null

FmtDateTime

public FmtDateTime(DateTimeFormatter formatter)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied formatter.

Parameters:

formatter - the formatter to use

Throws:

NullPointerException - if formatter is null

FmtDateTime

public FmtDateTime(DateTimeFormatter formatter,
                   CellProcessor next)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied formatter, then calls the next processor in the chain.

Parameters:

formatter - the formatter to use

next - the next processor in the chain

Throws:

NullPointerException - if formatter or next is null

FmtDateTime

public FmtDateTime(String pattern)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the default locale.

Parameters:

pattern - the pattern to use

Throws:

NullPointerException - if pattern is null

FmtDateTime

public FmtDateTime(String pattern,
                   CellProcessor next)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the default locale, then calls the next processor in the chain.

Parameters:

pattern - the pattern to use

next - the next processor in the chain

Throws:

NullPointerException - if pattern or next is null

FmtDateTime

public FmtDateTime(String pattern,
                   Locale locale)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the locale.

Parameters:

pattern - the pattern to use

locale - the locale to use (default used if null)

Throws:

NullPointerException - if pattern is null

FmtDateTime

public FmtDateTime(String pattern,
                   Locale locale,
                   CellProcessor next)

Constructs a new FmtDateTime processor, which formats a Joda DateTime as a String using the supplied pattern and the locale, then calls the next processor in the chain.

Parameters:

pattern - the pattern to use

locale - the locale to use (default used if null)

next - the next processor in the chain

Throws:

NullPointerException - if pattern or next is null

Method Detail

format

protected String format(DateTime jodaType,
                        DateTimeFormatter formatter)

Formats the Joda type as a String using a DateTimeFormatter.

Specified by:

format in class AbstractJodaFormattingProcessor<DateTime>

Parameters:

jodaType - the Joda type to format

formatter - the formatter to use

Returns:

the formatted String

format

protected String format(DateTime jodaType,
                        String pattern,
                        Locale locale)

Formats the Joda type as a String using the supplied pattern and (optional) locale.

Specified by:

format in class AbstractJodaFormattingProcessor<DateTime>

Parameters:

jodaType - the Joda type to format

pattern - the pattern to use

locale - the (optional) locale

Returns:

the formatted String

format

protected String format(DateTime jodaType)

Formats the Joda type as a String using the default pattern and locale.

Specified by:

format in class AbstractJodaFormattingProcessor<DateTime>

Parameters:

jodaType - the Joda type to format

Returns:

the formatted String