Modifier and Type	Class and Description
private static class	CellNumberFormatter.GeneralNumberFormatter
pack-priv static class	CellNumberFormatter.Special This class is used to mark where the special characters in the format are, as opposed to the other characters that are simply printed.

Modifier and Type	Field and Description
private final CellNumberFormatter.Special	afterFractional
private final CellNumberFormatter.Special	afterInteger
private final DecimalFormat	decimalFmt
private final CellNumberFormatter.Special	decimalPoint
private final String	denominatorFmt
private final List<CellNumberFormatter.Special>	denominatorSpecials
private final String	desc
private final CellNumberFormatter.Special	exponent
private final List<CellNumberFormatter.Special>	exponentDigitSpecials
private final List<CellNumberFormatter.Special>	exponentSpecials
private final List<CellNumberFormatter.Special>	fractionalSpecials
private final boolean	improperFraction
private final List<CellNumberFormatter.Special>	integerSpecials
private static final Logger	LOG
private final int	maxDenominator
private final CellNumberFormatter.Special	numerator
private final String	numeratorFmt
private final List<CellNumberFormatter.Special>	numeratorSpecials
private final String	printfFmt
private final double	scale
private final boolean	showGroupingSeparator
private final CellFormatter	SIMPLE_NUMBER
private final CellNumberFormatter.Special	slash
private final List<CellNumberFormatter.Special>	specials

Access	Constructor and Description
public	CellNumberFormatter(String The format to parse. format) Creates a new cell number formatter.
public	CellNumberFormatter(Locale The locale to use. locale, String The format to parse. format) Creates a new cell number formatter.

Method Summary

Modifier and Type	Method and Description
private int	calculateIntegerPartWidth()
private static CellNumberStringMod	deleteMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive)
public void	formatValue(StringBuffer The buffer to append to. toAppendTo, Object The value to format. valueObject) Implements abstract org.apache.poi.ss.format.CellFormatter.formatValue. Format a value according the format string.
private int	fractionalEnd()
private DecimalFormatSymbols	getDecimalFormatSymbols()
private static boolean	hasChar(char ch, List<CellNumberFormatter.Special> numSpecials)
private static boolean	hasChar(char ch, List<CellNumberFormatter.Special> numSpecials1, List<CellNumberFormatter.Special> numSpecials2)
private static boolean	hasChar(char ch, List<CellNumberFormatter.Special> numSpecials1, List<CellNumberFormatter.Special> numSpecials2, List<CellNumberFormatter.Special> numSpecials3)
private static CellNumberStringMod	insertMod(CellNumberFormatter.Special special, CharSequence toAdd, int where)
private int	integerEnd()
private static boolean	interpretIntegerCommas(StringBuffer sb, List<CellNumberFormatter.Special> specials, CellNumberFormatter.Special decimalPoint, int integerEnd, int fractionalEnd, double[] scale)
private static int	interpretPrecision(CellNumberFormatter.Special decimalPoint, List<CellNumberFormatter.Special> specials)
private static boolean	isDigitFmt(CellNumberFormatter.Special s)
private static CellNumberFormatter.Special	lastSpecial(List<CellNumberFormatter.Special> s)
private String	localiseFormat(String format)
private static int	maxValue(List<CellNumberFormatter.Special> s)
private static void	placeZeros(StringBuffer sb, List<CellNumberFormatter.Special> specials)
private static String	replaceLast(String text, String regex, String replacement)
private static CellNumberStringMod	replaceMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive, char withChar)
public void	simpleValue(StringBuffer The buffer to append to. toAppendTo, Object The value to format. value) Implements abstract org.apache.poi.ss.format.CellFormatter.simpleValue. Format a value according to the type, in the most basic way.
private static String	singleNumberFormat(List<CellNumberFormatter.Special> numSpecials)
private List<CellNumberFormatter.Special>	specialsFor(int pos, int takeFirst)
private List<CellNumberFormatter.Special>	specialsFor(int pos)
private void	writeFraction(double value, StringBuffer result, double fractional, StringBuffer output, Set<CellNumberStringMod> mods)
private void	writeFractional(StringBuffer result, StringBuffer output)
private void	writeInteger(StringBuffer result, StringBuffer output, List<CellNumberFormatter.Special> numSpecials, Set<CellNumberStringMod> mods, boolean showGroupingSeparator)
private void	writeScientific(double value, StringBuffer output, Set<CellNumberStringMod> mods)
private void	writeSingleInteger(String fmt, int num, StringBuffer output, List<CellNumberFormatter.Special> numSpecials, Set<CellNumberStringMod> mods)

Inherited from org.apache.poi.ss.format.CellFormatter:: format quote simpleFormat

Field Detail

afterFractional	back to summary
private final CellNumberFormatter.Special afterFractional

afterInteger	back to summary
private final CellNumberFormatter.Special afterInteger

decimalFmt	back to summary
private final DecimalFormat decimalFmt

decimalPoint	back to summary
private final CellNumberFormatter.Special decimalPoint

denominatorFmt	back to summary
private final String denominatorFmt

denominatorSpecials	back to summary
private final List<CellNumberFormatter.Special> denominatorSpecials

desc	back to summary
private final String desc

exponent	back to summary
private final CellNumberFormatter.Special exponent

exponentDigitSpecials	back to summary
private final List<CellNumberFormatter.Special> exponentDigitSpecials

exponentSpecials	back to summary
private final List<CellNumberFormatter.Special> exponentSpecials

fractionalSpecials	back to summary
private final List<CellNumberFormatter.Special> fractionalSpecials

improperFraction	back to summary
private final boolean improperFraction

integerSpecials	back to summary
private final List<CellNumberFormatter.Special> integerSpecials

LOG	back to summary
private static final Logger LOG

maxDenominator	back to summary
private final int maxDenominator

numerator	back to summary
private final CellNumberFormatter.Special numerator

numeratorFmt	back to summary
private final String numeratorFmt

numeratorSpecials	back to summary
private final List<CellNumberFormatter.Special> numeratorSpecials

printfFmt	back to summary
private final String printfFmt

scale	back to summary
private final double scale

showGroupingSeparator	back to summary
private final boolean showGroupingSeparator

SIMPLE_NUMBER	back to summary
private final CellFormatter SIMPLE_NUMBER

slash	back to summary
private final CellNumberFormatter.Special slash

specials	back to summary
private final List<CellNumberFormatter.Special> specials

Constructor Detail

CellNumberFormatter	back to summary
public CellNumberFormatter(String format) Creates a new cell number formatter. Parameters format:String The format to parse.

CellNumberFormatter

back to summary

public CellNumberFormatter(String format)

Creates a new cell number formatter.

Parameters

format:String: The format to parse.

CellNumberFormatter	back to summary
public CellNumberFormatter(Locale locale, String format) Creates a new cell number formatter. Parameters locale:Locale The locale to use. format:String The format to parse.

CellNumberFormatter

back to summary

public CellNumberFormatter(Locale locale, String format)

Creates a new cell number formatter.

Parameters

locale:Locale: The locale to use.
format:String: The format to parse.

Method Detail

calculateIntegerPartWidth	back to summary
private int calculateIntegerPartWidth()

deleteMod	back to summary
private static CellNumberStringMod deleteMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive)

formatValue	back to summary
public void formatValue(StringBuffer toAppendTo, Object valueObject) Implements abstract org.apache.poi.ss.format.CellFormatter.formatValue. Doc from org.apache.poi.ss.format.CellFormatter.formatValue. 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. Parameters toAppendTo:StringBuffer The buffer to append to. valueObject:Object The value to format. Annotations @Override

formatValue

back to summary

public void formatValue(StringBuffer toAppendTo, Object valueObject)

Implements abstract org.apache.poi.ss.format.CellFormatter.formatValue.

Doc from org.apache.poi.ss.format.CellFormatter.formatValue.

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.

Parameters

toAppendTo:StringBuffer: The buffer to append to.
valueObject:Object: The value to format.

Annotations

@Override

fractionalEnd	back to summary
private int fractionalEnd()

getDecimalFormatSymbols	back to summary
private DecimalFormatSymbols getDecimalFormatSymbols()

hasChar	back to summary
private static boolean hasChar(char ch, List<CellNumberFormatter.Special> numSpecials)

hasChar	back to summary
private static boolean hasChar(char ch, List<CellNumberFormatter.Special> numSpecials1, List<CellNumberFormatter.Special> numSpecials2)

hasChar	back to summary
private static boolean hasChar(char ch, List<CellNumberFormatter.Special> numSpecials1, List<CellNumberFormatter.Special> numSpecials2, List<CellNumberFormatter.Special> numSpecials3)

insertMod	back to summary
private static CellNumberStringMod insertMod(CellNumberFormatter.Special special, CharSequence toAdd, int where)

integerEnd	back to summary
private int integerEnd()

interpretIntegerCommas	back to summary
private static boolean interpretIntegerCommas(StringBuffer sb, List<CellNumberFormatter.Special> specials, CellNumberFormatter.Special decimalPoint, int integerEnd, int fractionalEnd, double[] scale)

interpretPrecision	back to summary
private static int interpretPrecision(CellNumberFormatter.Special decimalPoint, List<CellNumberFormatter.Special> specials)

isDigitFmt	back to summary
private static boolean isDigitFmt(CellNumberFormatter.Special s)

lastSpecial	back to summary
private static CellNumberFormatter.Special lastSpecial(List<CellNumberFormatter.Special> s)

localiseFormat	back to summary
private String localiseFormat(String format)

maxValue	back to summary
private static int maxValue(List<CellNumberFormatter.Special> s)

placeZeros	back to summary
private static void placeZeros(StringBuffer sb, List<CellNumberFormatter.Special> specials)

replaceLast	back to summary
private static String replaceLast(String text, String regex, String replacement)

replaceMod	back to summary
private static CellNumberStringMod replaceMod(CellNumberFormatter.Special start, boolean startInclusive, CellNumberFormatter.Special end, boolean endInclusive, char withChar)

simpleValue back to summary

simpleValue	back to summary
public void simpleValue(StringBuffer toAppendTo, Object value) Implements abstract org.apache.poi.ss.format.CellFormatter.simpleValue. Doc from org.apache.poi.ss.format.CellFormatter.simpleValue. 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 number, this is `"#"` for integer values, and `"#.#"` for floating-point values. Parameters toAppendTo:StringBuffer The buffer to append to. value:Object The value to format. Annotations @Override

public void simpleValue(StringBuffer toAppendTo, Object value)

Implements abstract org.apache.poi.ss.format.CellFormatter.simpleValue.

Doc from org.apache.poi.ss.format.CellFormatter.simpleValue.

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

Note

For a number, this is "#" for integer values, and "#.#" for floating-point values.

Parameters

toAppendTo:StringBuffer: The buffer to append to.
value:Object: The value to format.

Annotations

@Override

singleNumberFormat	back to summary
private static String singleNumberFormat(List<CellNumberFormatter.Special> numSpecials)

specialsFor	back to summary
private List<CellNumberFormatter.Special> specialsFor(int pos, int takeFirst)

specialsFor	back to summary
private List<CellNumberFormatter.Special> specialsFor(int pos)

writeFraction	back to summary
private void writeFraction(double value, StringBuffer result, double fractional, StringBuffer output, Set<CellNumberStringMod> mods) Annotations @SuppressWarnings:unchecked

writeFractional	back to summary
private void writeFractional(StringBuffer result, StringBuffer output)

writeInteger	back to summary
private void writeInteger(StringBuffer result, StringBuffer output, List<CellNumberFormatter.Special> numSpecials, Set<CellNumberStringMod> mods, boolean showGroupingSeparator)

writeScientific	back to summary
private void writeScientific(double value, StringBuffer output, Set<CellNumberStringMod> mods)

writeSingleInteger	back to summary
private void writeSingleInteger(String fmt, int num, StringBuffer output, List<CellNumberFormatter.Special> numSpecials, Set<CellNumberStringMod> mods)

org.apache.poi.ss.format back to summary

private Class CellNumberFormatter.GeneralNumberFormatter

Class Inheritance

extends CellFormatter

java.lang.Object
org.apache.poi.ss.format.CellFormatter
org.apache.poi.ss.format.CellNumberFormatter.GeneralNumberFormatter

Field Summary

Inherited from org.apache.poi.ss.format.CellFormatter:: format locale

Constructor Summary

Access	Constructor and Description
private	GeneralNumberFormatter(Locale locale)

Method Summary

Modifier and Type	Method and Description
public void	formatValue(StringBuffer The buffer to append to. toAppendTo, Object The value to format. value) Implements abstract org.apache.poi.ss.format.CellFormatter.formatValue. Format a value according the format string.
public void	simpleValue(StringBuffer The buffer to append to. toAppendTo, Object The value to format. value) Implements abstract org.apache.poi.ss.format.CellFormatter.simpleValue. Format a value according to the type, in the most basic way.

Inherited from org.apache.poi.ss.format.CellFormatter:: format quote simpleFormat

Constructor Detail

GeneralNumberFormatter	back to summary
private GeneralNumberFormatter(Locale locale)

Method Detail

formatValue

back to summary

public void formatValue(StringBuffer toAppendTo, Object value)

Implements abstract org.apache.poi.ss.format.CellFormatter.formatValue.

Doc from org.apache.poi.ss.format.CellFormatter.formatValue.

Format a value according the format string.

Note

Parameters

toAppendTo:StringBuffer: The buffer to append to.
value:Object: The value to format.

Annotations

@Override

simpleValue

back to summary

public void simpleValue(StringBuffer toAppendTo, Object value)

Implements abstract org.apache.poi.ss.format.CellFormatter.simpleValue.

Doc from org.apache.poi.ss.format.CellFormatter.simpleValue.

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

Note

Parameters

toAppendTo:StringBuffer: The buffer to append to.
value:Object: The value to format.

Annotations

@Override

org.apache.poi.ss.format back to summary

pack-priv Class CellNumberFormatter.Special

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.format.CellNumberFormatter.Special

This class is used to mark where the special characters in the format are, as opposed to the other characters that are simply printed.

Field Summary

Modifier and Type	Field and Description
pack-priv final char	ch
pack-priv int	pos

Constructor Summary

Access	Constructor and Description
pack-priv	Special(char ch, int pos)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ch	back to summary
pack-priv final char ch

pos	back to summary
pack-priv int pos

Constructor Detail

Special	back to summary
pack-priv Special(char ch, int pos)

Method Detail

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class CellNumberFormatter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CellNumberFormatter.GeneralNumberFormatter

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class CellNumberFormatter.Special

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail