org.apache.poi.ss.format

Class CellFormatter

java.lang.Object

org.apache.poi.ss.format.CellFormatter

Direct Known Subclasses:

CellDateFormatter, CellElapsedFormatter, CellGeneralFormatter, CellNumberFormatter, CellTextFormatter

public abstract class CellFormatter
extends java.lang.Object

This is the abstract supertype for the various cell formatters.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Locale	LOCALE This is the locale used to get a consistent format result from which to work.

Constructor Summary

Constructors

Constructor and Description
CellFormatter(java.lang.String format) Creates a new formatter object, storing the format in format.

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.lang.Object value) Formats the value, returning the resulting string.
abstract void	formatValue(java.lang.StringBuffer toAppendTo, java.lang.Object value) Format a value according the format string.
java.lang.String	simpleFormat(java.lang.Object value) Formats the value in the most basic way, returning the resulting string.
abstract void	simpleValue(java.lang.StringBuffer toAppendTo, java.lang.Object value) Format a value according to the type, in the most basic way.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE

public static final java.util.Locale LOCALE

This is the locale used to get a consistent format result from which to work.

Constructor Detail

CellFormatter

public CellFormatter(java.lang.String format)

Creates a new formatter object, storing the format in format.

Parameters:

format - The format.

Method Detail

formatValue

public abstract void formatValue(java.lang.StringBuffer toAppendTo,
                                 java.lang.Object value)

Format a value according the format string.

Parameters:

toAppendTo - The buffer to append to.

value - The value to format.

simpleValue

public abstract void simpleValue(java.lang.StringBuffer toAppendTo,
                                 java.lang.Object value)

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

Parameters:

toAppendTo - The buffer to append to.

value - The value to format.

format

public java.lang.String format(java.lang.Object value)

Formats the value, returning the resulting string.

Parameters:

value - The value to format.

Returns:

The value, formatted.

simpleFormat

public java.lang.String simpleFormat(java.lang.Object value)

Formats the value in the most basic way, returning the resulting string.

Parameters:

value - The value to format.

Returns:

The value, formatted.