Package fr.becpg.config.format

Class PropertyFormats

java.lang.Object

fr.becpg.config.format.PropertyFormats

public class PropertyFormats
extends Object

Modern Java 17 implementation using DateTimeFormatter and Records Provides better performance, thread safety, and immutability

Author:

querephi, matthieu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PropertyFormats.FormatConfig

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	COMPARE_MAX_PRECISION	Constant COMPARE_MAX_PRECISION=9
private static final String	CSV_DATE_FORMAT	Constant CSV_DATE_FORMAT="MM/dd/yyyy"
private static final String	CSV_DATETIME_FORMAT	Constant CSV_DATETIME_FORMAT="MM/dd/yyyy HH:mm:ss"
private static final ConcurrentHashMap<PropertyFormats.FormatConfig,DateTimeFormatter>	DATE_FORMATTER_CACHE	Constant DATE_FORMATTER_CACHE
private final String	datePattern
private final String	datetimePattern
private final String	decimalPattern
private static final String	DEFAULT_DATE_PATTERN	Constant DEFAULT_DATE_PATTERN="EEE d MMM yyyy"
private static final String	DEFAULT_DATETIME_PATTERN	Constant DEFAULT_DATETIME_PATTERN="EEE d MMM yyyy HH:mm:ss"
static final String	DEFAULT_DECIMAL_PATTERN	Constant DEFAULT_DECIMAL_PATTERN="###,###
private static final String	FRENCH_CSV_DATE_FORMAT	Constant FRENCH_CSV_DATE_FORMAT="dd/MM/yyyy"
private static final String	FRENCH_CSV_DATETIME_FORMAT	Constant FRENCH_CSV_DATETIME_FORMAT="dd/MM/yyyy HH:mm:ss"
private final Integer	maxDecimalPrecision
private static final ConcurrentHashMap<String,PropertyFormats>	MODE_CACHE	Constant MODE_CACHE
private static final ConcurrentHashMap<PropertyFormats.FormatConfig,NumberFormat>	NUMBER_FORMATTER_CACHE	Constant NUMBER_FORMATTER_CACHE
static final String	PROCESS_DATE_FORMAT	Constant PROCESS_DATE_FORMAT="dd MMMM, yyyy"
private final boolean	useDefaultLocale

Constructor Summary

Constructors

Constructor	Description
PropertyFormats(boolean useDefaultLocale)	Constructor for PropertyFormats.
PropertyFormats(boolean useDefaultLocale, String datePattern, String datetimePattern, String decimalPattern)	Constructor for PropertyFormats.
PropertyFormats(boolean useDefaultLocale, String datePattern, String datetimePattern, String decimalPattern, Integer maxDecimalPrecision)	Constructor for PropertyFormats.

Method Summary

Modifier and Type	Method	Description
static void	clearFormatCache()	clearFormatCache.
private PropertyFormats.FormatConfig	configFor(String pattern)	Binds a pattern to the locale of the current thread.
private Date	convertToDate(LocalDateTime localDateTime)	convertToDate.
private LocalDate	convertToLocalDate(Date date)	convertToLocalDate.
private LocalDateTime	convertToLocalDateTime(Date date)	convertToLocalDateTime.
private DateTimeFormatter	createDateTimeFormatter(PropertyFormats.FormatConfig config)	createDateTimeFormatter.
private NumberFormat	createNumberFormat(PropertyFormats.FormatConfig config)	createNumberFormat.
String	formatDate(Object o)	formatDate.
String	formatDateTime(Object o)	formatDateTime.
String	formatDecimal(Object o)	formatDecimal.
private String	formatWithPrecision(Double qty, NumberFormat baseFormatter)	formatWithPrecision.
static PropertyFormats	forMode(FormatMode mode, boolean useServerLocale)	forMode.
private DateTimeFormatter	getDateFormatter()	getDateFormatter.
String	getDatePattern()	Getter for the field datePattern.
private DateTimeFormatter	getDateTimeFormatter()	getDateTimeFormatter.
String	getDatetimePattern()	Getter for the field datetimePattern.
DecimalFormat	getDecimalFormat()	getDecimalFormat.
String	getDecimalPattern()	Getter for the field decimalPattern.
Integer	getMaxDecimalPrecision()	Getter for the field maxDecimalPrecision.
private NumberFormat	getNumberFormatter()	getNumberFormatter.
boolean	isUseDefaultLocale()	isUseDefaultLocale.
private static String	modeCacheKey(FormatMode mode, boolean useServerLocale)	Builds the cache key of a shared instance.
Date	parseDate(String dateString)	parseDate.
Date	parseDateTime(String dateString)	parseDateTime.
Number	parseDecimal(String decimalString)	parseDecimal.
PropertyFormats	withDateFormat(String dateFormat)	withDateFormat.
PropertyFormats	withDateTimeFormat(String datetimeFormat)	withDateTimeFormat.
PropertyFormats	withDatetimePattern(String pattern)	Factory method to create a new instance with a different datetime pattern
PropertyFormats	withDecimalFormat(String decimalFormat)	withDecimalFormat.

Methods inherited from class java.lang.Object

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

Field Details

DATE_FORMATTER_CACHE

private static final ConcurrentHashMap<PropertyFormats.FormatConfig,DateTimeFormatter> DATE_FORMATTER_CACHE

Constant DATE_FORMATTER_CACHE

NUMBER_FORMATTER_CACHE

private static final ConcurrentHashMap<PropertyFormats.FormatConfig,NumberFormat> NUMBER_FORMATTER_CACHE

Constant NUMBER_FORMATTER_CACHE

MODE_CACHE

private static final ConcurrentHashMap<String,PropertyFormats> MODE_CACHE

Constant MODE_CACHE

DEFAULT_DATE_PATTERN

private static final String DEFAULT_DATE_PATTERN

Constant DEFAULT_DATE_PATTERN="EEE d MMM yyyy"

See Also:

• Constant Field Values

DEFAULT_DATETIME_PATTERN

private static final String DEFAULT_DATETIME_PATTERN

Constant DEFAULT_DATETIME_PATTERN="EEE d MMM yyyy HH:mm:ss"

See Also:

• Constant Field Values

DEFAULT_DECIMAL_PATTERN

public static final String DEFAULT_DECIMAL_PATTERN

Constant DEFAULT_DECIMAL_PATTERN="###,###.####"

See Also:

• Constant Field Values

PROCESS_DATE_FORMAT

public static final String PROCESS_DATE_FORMAT

Constant PROCESS_DATE_FORMAT="dd MMMM, yyyy"

See Also:

• Constant Field Values

FRENCH_CSV_DATETIME_FORMAT

private static final String FRENCH_CSV_DATETIME_FORMAT

Constant FRENCH_CSV_DATETIME_FORMAT="dd/MM/yyyy HH:mm:ss"

See Also:

• Constant Field Values

CSV_DATETIME_FORMAT

private static final String CSV_DATETIME_FORMAT

Constant CSV_DATETIME_FORMAT="MM/dd/yyyy HH:mm:ss"

See Also:

• Constant Field Values

FRENCH_CSV_DATE_FORMAT

private static final String FRENCH_CSV_DATE_FORMAT

Constant FRENCH_CSV_DATE_FORMAT="dd/MM/yyyy"

See Also:

• Constant Field Values

CSV_DATE_FORMAT

private static final String CSV_DATE_FORMAT

Constant CSV_DATE_FORMAT="MM/dd/yyyy"

See Also:

• Constant Field Values

COMPARE_MAX_PRECISION

private static final int COMPARE_MAX_PRECISION

Constant COMPARE_MAX_PRECISION=9

See Also:

• Constant Field Values

useDefaultLocale

private final boolean useDefaultLocale

maxDecimalPrecision

private final Integer maxDecimalPrecision

datePattern

private final String datePattern

datetimePattern

private final String datetimePattern

decimalPattern

private final String decimalPattern

Constructor Details

PropertyFormats

public PropertyFormats(boolean useDefaultLocale)

Constructor for PropertyFormats.

Parameters:

useDefaultLocale - a boolean

PropertyFormats

public PropertyFormats(boolean useDefaultLocale,
 String datePattern,
 String datetimePattern,
 String decimalPattern)

Constructor for PropertyFormats.

Parameters:

useDefaultLocale - a boolean

datePattern - a String object

datetimePattern - a String object

decimalPattern - a String object

PropertyFormats

public PropertyFormats(boolean useDefaultLocale,
 String datePattern,
 String datetimePattern,
 String decimalPattern,
 Integer maxDecimalPrecision)

Constructor for PropertyFormats.

Parameters:

useDefaultLocale - a boolean

datePattern - a String object

datetimePattern - a String object

decimalPattern - a String object

maxDecimalPrecision - a Integer object

Method Details

withDateFormat

public PropertyFormats withDateFormat(String dateFormat)

withDateFormat.

Parameters:

dateFormat - a String object

Returns:

a PropertyFormats object

withDateTimeFormat

public PropertyFormats withDateTimeFormat(String datetimeFormat)

withDateTimeFormat.

Parameters:

datetimeFormat - a String object

Returns:

a PropertyFormats object

withDecimalFormat

public PropertyFormats withDecimalFormat(String decimalFormat)

withDecimalFormat.

Parameters:

decimalFormat - a String object

Returns:

a PropertyFormats object

forMode

public static PropertyFormats forMode(FormatMode mode,
 boolean useServerLocale)

forMode.

Parameters:

mode - a FormatMode object

useServerLocale - a boolean

Returns:

a PropertyFormats object

modeCacheKey

private static String modeCacheKey(FormatMode mode,
 boolean useServerLocale)

Builds the cache key of a shared instance.

The CSV patterns are picked from the content locale, so that locale belongs to the key: without it the first export would impose its date layout on all the others.

Parameters:

mode - a FormatMode object

useServerLocale - a boolean

Returns:

a String object

withDatetimePattern

public PropertyFormats withDatetimePattern(String pattern)

Factory method to create a new instance with a different datetime pattern

Parameters:

pattern - the new datetime pattern to use

Returns:

a new PropertyFormats instance with the updated datetime pattern

formatDate

public String formatDate(Object o)

formatDate.

Parameters:

o - a Object object

Returns:

a String object

formatDateTime

public String formatDateTime(Object o)

formatDateTime.

Parameters:

o - a Object object

Returns:

a String object

formatDecimal

public String formatDecimal(Object o)

formatDecimal.

Parameters:

o - a Object object

Returns:

a String object

formatWithPrecision

private String formatWithPrecision(Double qty,
 NumberFormat baseFormatter)

formatWithPrecision.

Parameters:

qty - a Double object

baseFormatter - a NumberFormat object

Returns:

a String object

parseDate

public Date parseDate(String dateString)
               throws ParseException

parseDate.

Parameters:

dateString - a String object

Returns:

a Date object

Throws:

ParseException - if any.

parseDateTime

public Date parseDateTime(String dateString)
                   throws ParseException

parseDateTime.

Parameters:

dateString - a String object

Returns:

a Date object

Throws:

ParseException - if any.

parseDecimal

public Number parseDecimal(String decimalString)
                    throws ParseException

parseDecimal.

Parameters:

decimalString - a String object

Returns:

a Number object

Throws:

ParseException - if any.

getDateFormatter

private DateTimeFormatter getDateFormatter()

getDateFormatter.

Returns:

a DateTimeFormatter object

getDateTimeFormatter

private DateTimeFormatter getDateTimeFormatter()

getDateTimeFormatter.

Returns:

a DateTimeFormatter object

getNumberFormatter

private NumberFormat getNumberFormatter()

getNumberFormatter.

Returns:

a NumberFormat object

configFor

private PropertyFormats.FormatConfig configFor(String pattern)

Binds a pattern to the locale of the current thread.

The locale must be resolved on each call: instances returned by forMode(FormatMode, boolean) are shared between requests, so capturing the locale once would format every later request in the locale of the first one.

Parameters:

pattern - a String object

Returns:

a PropertyFormats.FormatConfig object

createDateTimeFormatter

private DateTimeFormatter createDateTimeFormatter(PropertyFormats.FormatConfig config)

createDateTimeFormatter.

Parameters:

config - a PropertyFormats.FormatConfig object

Returns:

a DateTimeFormatter object

createNumberFormat

private NumberFormat createNumberFormat(PropertyFormats.FormatConfig config)

createNumberFormat.

Parameters:

config - a PropertyFormats.FormatConfig object

Returns:

a NumberFormat object

convertToLocalDate

private LocalDate convertToLocalDate(Date date)

convertToLocalDate.

Parameters:

date - a Date object

Returns:

a LocalDate object

convertToLocalDateTime

private LocalDateTime convertToLocalDateTime(Date date)

convertToLocalDateTime.

Parameters:

date - a Date object

Returns:

a LocalDateTime object

convertToDate

private Date convertToDate(LocalDateTime localDateTime)

convertToDate.

Parameters:

localDateTime - a LocalDateTime object

Returns:

a Date object

isUseDefaultLocale

public boolean isUseDefaultLocale()

isUseDefaultLocale.

Returns:

a boolean

getMaxDecimalPrecision

public Integer getMaxDecimalPrecision()

Getter for the field maxDecimalPrecision.

Returns:

a Integer object

getDatePattern

public String getDatePattern()

Getter for the field datePattern.

Returns:

a String object

getDatetimePattern

public String getDatetimePattern()

Getter for the field datetimePattern.

Returns:

a String object

getDecimalPattern

public String getDecimalPattern()

Getter for the field decimalPattern.

Returns:

a String object

getDecimalFormat

public DecimalFormat getDecimalFormat()

getDecimalFormat.

Returns:

a DecimalFormat object

clearFormatCache

public static void clearFormatCache()

clearFormatCache.