org.supercsv.cellprocessor

Class FmtDate

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

org.supercsv.cellprocessor.FmtDate

All Implemented Interfaces:

CellProcessor, DateCellProcessor

public class FmtDate
extends CellProcessorAdaptor
implements DateCellProcessor

Converts a date into a formatted string using the SimpleDateFormat class. If you want to convert from a String to a Date, use the ParseDate processor.

Some example date formats you can use are:
"dd/MM/yyyy" (formats a date as "25/12/2011")
"dd-MMM-yy" (formats a date as "25-Dec-11")
"yyyy.MM.dd.HH.mm.ss" (formats a date as "2011.12.25.08.36.33"
"E, dd MMM yyyy HH:mm:ss Z" (formats a date as "Tue, 25 Dec 2011 08:36:33 -0500")

Since:

1.50

Author:

Dominique De Vito, James Bassett

Field Summary

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Constructor Summary

Constructors

Constructor and Description
FmtDate(String dateFormat) Constructs a new FmtDate processor, which converts a date into a formatted string using SimpleDateFormat.
FmtDate(String dateFormat, StringCellProcessor next) Constructs a new FmtDate processor, which converts a date into a formatted string using SimpleDateFormat, 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.

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

FmtDate

public FmtDate(String dateFormat)

Constructs a new FmtDate processor, which converts a date into a formatted string using SimpleDateFormat.

Parameters:

dateFormat - the date format String (see SimpleDateFormat)

Throws:

NullPointerException - if dateFormat is null

FmtDate

public FmtDate(String dateFormat,
               StringCellProcessor next)

Constructs a new FmtDate processor, which converts a date into a formatted string using SimpleDateFormat, then calls the next processor in the chain.

Parameters:

dateFormat - the date format String (see SimpleDateFormat)

next - the next processor in the chain

Throws:

NullPointerException - if dateFormat 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.

Specified by:

execute in interface CellProcessor

Parameters:

value - the value to be processed

context - the CSV context

Returns:

the result of cell processor execution

Throws:

SuperCsvCellProcessorException - if value is null or is not a Date, or if dateFormat is not a valid date format