Package org.xlsx4j.org.apache.poi.ss.usermodel

Class ExcelStyleDateFormatter

java.lang.Object

java.text.Format

java.text.DateFormat

java.text.SimpleDateFormat

org.xlsx4j.org.apache.poi.ss.usermodel.ExcelStyleDateFormatter

All Implemented Interfaces:

Serializable, Cloneable

public class ExcelStyleDateFormatter
extends SimpleDateFormat

A wrapper around a SimpleDateFormat instance, which handles a few Excel-style extensions that are not supported by SimpleDateFormat. Currently, the extensions are around the handling of elapsed time, eg rendering 1 day 2 hours as 26 hours.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.DateFormat

DateFormat.Field

Field Summary

Fields

Modifier and Type	Field	Description
private double	dateToBeFormatted
private static final DecimalFormat	format1digit
private static final DecimalFormat	format2digits
private static final DecimalFormat	format3digit
private static final DecimalFormat	format4digits
static final char	H_BRACKET_SYMBOL
static final char	HH_BRACKET_SYMBOL
static final char	L_BRACKET_SYMBOL
static final char	LL_BRACKET_SYMBOL
static final char	M_BRACKET_SYMBOL
static final char	MM_BRACKET_SYMBOL
static final char	MMMMM_START_SYMBOL
static final char	MMMMM_TRUNCATE_SYMBOL
static final char	S_BRACKET_SYMBOL
static final char	SS_BRACKET_SYMBOL

Fields inherited from class java.text.DateFormat

AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD

Constructor Summary

Constructors

Constructor	Description
ExcelStyleDateFormatter(String pattern)
ExcelStyleDateFormatter(String pattern, DateFormatSymbols formatSymbols)
ExcelStyleDateFormatter(String pattern, Locale locale)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
StringBuffer	format(Date date, StringBuffer paramStringBuffer, FieldPosition paramFieldPosition)
int	hashCode()
private static String	processFormatPattern(String f)	Takes a format String, and replaces Excel specific bits with our detection sequences
void	setDateToBeFormatted(double date)	Used to let us know what the date being formatted is, in Excel terms, which we may wish to use when handling elapsed times.

Methods inherited from class java.text.SimpleDateFormat

applyLocalizedPattern, applyPattern, clone, formatToCharacterIterator, get2DigitYearStart, getDateFormatSymbols, parse, set2DigitYearStart, setDateFormatSymbols, toLocalizedPattern, toPattern

Methods inherited from class java.text.DateFormat

format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, isLenient, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone

Methods inherited from class java.text.Format

format, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

MMMMM_START_SYMBOL

public static final char MMMMM_START_SYMBOL

See Also:

• Constant Field Values

MMMMM_TRUNCATE_SYMBOL

public static final char MMMMM_TRUNCATE_SYMBOL

See Also:

• Constant Field Values

H_BRACKET_SYMBOL

public static final char H_BRACKET_SYMBOL

See Also:

• Constant Field Values

HH_BRACKET_SYMBOL

public static final char HH_BRACKET_SYMBOL

See Also:

• Constant Field Values

M_BRACKET_SYMBOL

public static final char M_BRACKET_SYMBOL

See Also:

• Constant Field Values

MM_BRACKET_SYMBOL

public static final char MM_BRACKET_SYMBOL

See Also:

• Constant Field Values

S_BRACKET_SYMBOL

public static final char S_BRACKET_SYMBOL

See Also:

• Constant Field Values

SS_BRACKET_SYMBOL

public static final char SS_BRACKET_SYMBOL

See Also:

• Constant Field Values

L_BRACKET_SYMBOL

public static final char L_BRACKET_SYMBOL

See Also:

• Constant Field Values

LL_BRACKET_SYMBOL

public static final char LL_BRACKET_SYMBOL

See Also:

• Constant Field Values

format1digit

private static final DecimalFormat format1digit

format2digits

private static final DecimalFormat format2digits

format3digit

private static final DecimalFormat format3digit

format4digits

private static final DecimalFormat format4digits

dateToBeFormatted

private double dateToBeFormatted

Constructor Details

ExcelStyleDateFormatter

public ExcelStyleDateFormatter(String pattern)

ExcelStyleDateFormatter

public ExcelStyleDateFormatter(String pattern,
 DateFormatSymbols formatSymbols)

ExcelStyleDateFormatter

public ExcelStyleDateFormatter(String pattern,
 Locale locale)

Method Details

processFormatPattern

private static String processFormatPattern(String f)

Takes a format String, and replaces Excel specific bits with our detection sequences

setDateToBeFormatted

public void setDateToBeFormatted(double date)

Used to let us know what the date being formatted is, in Excel terms, which we may wish to use when handling elapsed times.

format

public StringBuffer format(Date date,
 StringBuffer paramStringBuffer,
 FieldPosition paramFieldPosition)

Overrides:

format in class SimpleDateFormat

equals

public boolean equals(Object o)

Overrides:

equals in class SimpleDateFormat

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleDateFormat