com.atlassian.confluence.core
Interface FormatSettingsManager

All Known Implementing Classes:

DefaultFormatSettingsManager, TestingFormatSettingsManager

public interface FormatSettingsManager

Persistent storage and retrieval of format settings. Implementations should return a default value if no configuration currently exists.

Method Summary

String	getDateFormat() Returns the formatting pattern used for dates.
String	getDateTimeFormat() Returns the formatting pattern used for date and time together.
String	getDayFormat() Deprecated. since 3.5 this simply redirects to getDateFormat. Previously defaulted to "MMM dd"
String	getDecimalNumberFormat() Returns the formatting pattern used for decimal numbers.
String	getEditorBlogPostDate() Returns the date time format for the editor blog post date
String	getLongNumberFormat() Returns the formatting pattern used for integer numbers.
String	getTimeFormat() Returns the formatting pattern used for times.
void	setDateFormat(String pattern) Stores the formatting pattern to be used for dates.
void	setDateTimeFormat(String pattern) Stores the formatting pattern to be used for date and time together.
void	setDayFormat(String pattern) Deprecated. since 3.5 dayFormat is no longer supported
void	setDecimalNumberFormat(String pattern) Stores the formatting pattern to be used for decimal numbers.
void	setLongNumberFormat(String pattern) Stores the formatting pattern to be used for integer numbers.
void	setTimeFormat(String pattern) Stores the formatting pattern to be used for times.

Method Detail

getDateFormat

String getDateFormat()

Returns the formatting pattern used for dates. Typically something like "d MMM, yyyy".

setDateFormat

void setDateFormat(String pattern)

Stores the formatting pattern to be used for dates.

Parameters:

pattern - a pattern compatible with SimpleDateFormat

getTimeFormat

String getTimeFormat()

Returns the formatting pattern used for times. Typically something like "h:mm a".

setTimeFormat

void setTimeFormat(String pattern)

Stores the formatting pattern to be used for times.

Parameters:

pattern - a pattern compatible with SimpleDateFormat

getDateTimeFormat

String getDateTimeFormat()

Returns the formatting pattern used for date and time together. Typically something like "d MMM, yyyy HH:mm".

getDayFormat

@Deprecated
String getDayFormat()

Deprecated. since 3.5 this simply redirects to getDateFormat. Previously defaulted to "MMM dd"

Was previously a slightly shorter format for representing a day, usually without a year. Is now identical to getDateFormat().

Returns:

the String representation of the date format

setDayFormat

@Deprecated
void setDayFormat(String pattern)

Deprecated. since 3.5 dayFormat is no longer supported

Does nothing. Previously set the "dayFormat", which has been dropped in favour of always using getDateFormat().

See Also:

getDayFormat()

setDateTimeFormat

void setDateTimeFormat(String pattern)

Stores the formatting pattern to be used for date and time together.

Parameters:

pattern - a pattern compatible with SimpleDateFormat

getLongNumberFormat

String getLongNumberFormat()

Returns the formatting pattern used for integer numbers. Typically something like "###############".

setLongNumberFormat

void setLongNumberFormat(String pattern)

Stores the formatting pattern to be used for integer numbers.

Parameters:

pattern - a pattern compatible with DecimalFormat

getDecimalNumberFormat

String getDecimalNumberFormat()

Returns the formatting pattern used for decimal numbers. Typically something like "###############.##########".

getEditorBlogPostDate

String getEditorBlogPostDate()

Returns the date time format for the editor blog post date

setDecimalNumberFormat

void setDecimalNumberFormat(String pattern)

Stores the formatting pattern to be used for decimal numbers.

Parameters:

pattern - a pattern compatible with DecimalFormat