org.supercsv.cellprocessor.joda

Class AbstractJodaFormattingProcessor<T>

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

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

Type Parameters:

T - the Joda type that the processor formats

All Implemented Interfaces:

CellProcessor

Direct Known Subclasses:

FmtDateTime, FmtLocalDate, FmtLocalDateTime, FmtLocalTime

public abstract class AbstractJodaFormattingProcessor<T>
extends CellProcessorAdaptor

Abstract base class for cell processors converting Joda types to Strings.

Since:

2.3.0

Author:

James Bassett

Field Summary

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Constructor Summary

Constructors

Constructor and Description
AbstractJodaFormattingProcessor(Class<T> jodaClass) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String.
AbstractJodaFormattingProcessor(Class<T> jodaClass, CellProcessor next) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String, then calls the next processor in the chain.
AbstractJodaFormattingProcessor(Class<T> jodaClass, DateTimeFormatter formatter) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied formatter.
AbstractJodaFormattingProcessor(Class<T> jodaClass, DateTimeFormatter formatter, CellProcessor next) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied formatter, then calls the next processor in the chain.
AbstractJodaFormattingProcessor(Class<T> jodaClass, String pattern) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied pattern and the default locale.
AbstractJodaFormattingProcessor(Class<T> jodaClass, String pattern, CellProcessor next) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied pattern and the default locale, then calls the next processor in the chain.
AbstractJodaFormattingProcessor(Class<T> jodaClass, String pattern, Locale locale) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied pattern and the locale.
AbstractJodaFormattingProcessor(Class<T> jodaClass, String pattern, Locale locale, CellProcessor next) Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type 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
Object	execute(Object value, CsvContext context) This method is invoked by the framework when the processor needs to process data or check constraints.
protected abstract String	format(T jodaType) Formats the Joda type as a String using the default pattern and locale.
protected abstract String	format(T jodaType, DateTimeFormatter formatter) Formats the Joda type as a String using a DateTimeFormatter.
protected abstract String	format(T 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.CellProcessorAdaptor

toString, validateInputNotNull

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass)

Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String.

Parameters:

jodaClass - the Joda class that the processor formats

Throws:

NullPointerException - if jodaClass is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       CellProcessor next)

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

Parameters:

jodaClass - the Joda class that the processor formats

next - next processor in the chain

Throws:

NullPointerException - if jodaClass or next is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       DateTimeFormatter formatter)

Constructs a new AbstractJodaFormattingProcessor processor, which formats the Joda type as a String using the supplied formatter.

Parameters:

jodaClass - the Joda class that the processor formats

formatter - the formatter to use

Throws:

NullPointerException - if jodaClass or formatter is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       DateTimeFormatter formatter,
                                       CellProcessor next)

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

Parameters:

jodaClass - the Joda class that the processor formats

formatter - the formatter to use

next - the next processor in the chain

Throws:

NullPointerException - if jodaClass, formatter or next is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       String pattern)

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

Parameters:

jodaClass - the Joda class that the processor formats

pattern - the pattern to use

Throws:

NullPointerException - if jodaClass or pattern is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       String pattern,
                                       CellProcessor next)

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

Parameters:

jodaClass - the Joda class that the processor formats

pattern - the pattern to use

next - the next processor in the chain

Throws:

NullPointerException - if jodaClass, pattern or next is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       String pattern,
                                       Locale locale)

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

Parameters:

jodaClass - the Joda class that the processor formats

pattern - the pattern to use

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

Throws:

NullPointerException - if jodaClass or pattern is null

AbstractJodaFormattingProcessor

public AbstractJodaFormattingProcessor(Class<T> jodaClass,
                                       String pattern,
                                       Locale locale,
                                       CellProcessor next)

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

Parameters:

jodaClass - the Joda class that the processor formats

pattern - the pattern to use

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

next - the next processor in the chain

Throws:

NullPointerException - if jodaClass, pattern or next is null

Method Detail

execute

public Object execute(Object value,
                      CsvContext context)

This method is invoked by the framework when the processor needs to process data or check constraints.

Parameters:

value - the value to be processed

context - the CSV context

Returns:

the result of cell processor execution

Throws:

SuperCsvCellProcessorException - if value is null, not the correct type, or can't be formatted

format

protected abstract String format(T jodaType,
                                 DateTimeFormatter formatter)

Formats the Joda type as a String using a DateTimeFormatter.

Parameters:

jodaType - the Joda type to format

formatter - the formatter to use

Returns:

the formatted String

Throws:

IllegalArgumentException - if the Joda type couldn't be formatted

format

protected abstract String format(T jodaType,
                                 String pattern,
                                 Locale locale)

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

Parameters:

jodaType - the Joda type to format

pattern - the pattern to use

locale - the (optional) locale

Returns:

the formatted String

Throws:

IllegalArgumentException - if the Joda type couldn't be formatted

format

protected abstract String format(T jodaType)

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

Parameters:

jodaType - the Joda type to format

Returns:

the formatted String

Throws:

IllegalArgumentException - if the Joda type couldn't be formatted