org.apache.poi.ss.format

Class CellDateFormatter

java.lang.Object

org.apache.poi.ss.format.CellFormatter

org.apache.poi.ss.format.CellDateFormatter

public class CellDateFormatter
extends CellFormatter

Formats a date value.

Field Summary

Fields inherited from class org.apache.poi.ss.format.CellFormatter

format, locale

Constructor Summary

Constructors

Constructor and Description
CellDateFormatter(Locale locale, String format) Creates a new date formatter with the given specification.
CellDateFormatter(String format) Creates a new date formatter with the given specification.

Method Summary

Modifier and Type	Method and Description
void	formatValue(StringBuffer toAppendTo, Object value) Format a value according the format string.
void	simpleValue(StringBuffer toAppendTo, Object value) Format a value according to the type, in the most basic way.

Methods inherited from class org.apache.poi.ss.format.CellFormatter

format, simpleFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

CellDateFormatter

public CellDateFormatter(String format)

Creates a new date formatter with the given specification.

Parameters:

format - The format.

CellDateFormatter

public CellDateFormatter(Locale locale,
                         String format)

Creates a new date formatter with the given specification.

Parameters:

locale - The locale.

format - The format.

Method Detail

formatValue

public void formatValue(StringBuffer toAppendTo,
                        Object value)

Description copied from class: CellFormatter

Format a value according the format string.

NOTE: this method must be thread safe! In particular, if it uses a Format instance that is not thread safe, i.e. DateFormat, this method must be synchronized, either on the method, if the format is a final property, or on the format instance itself.

Specified by:

formatValue in class CellFormatter

Parameters:

toAppendTo - The buffer to append to.

value - The value to format.

simpleValue

public void simpleValue(StringBuffer toAppendTo,
                        Object value)

Format a value according to the type, in the most basic way.

NOTE: this method must be thread safe! In particular, if it uses a Format instance that is not thread safe, i.e. DateFormat, this method must be synchronized, either on the method, if the format is a final property, or on the format instance itself.

For a date, this is "mm/d/y".

Specified by:

simpleValue in class CellFormatter

Parameters:

toAppendTo - The buffer to append to.

value - The value to format.