Package org.cyclos.utils

Interface Formatter

All Known Implementing Classes:

AbstractFormatter, FormatterImpl

public interface Formatter

Contains methods used to format several types of data

Field Summary

Fields

Modifier and Type	Field	Description
static int	VARIABLE_SCALE	Value used when setting a number format with a custom scale, indicating that the scale is variable.

Method Summary

Modifier and Type	Method	Description
String	format(Boolean bool)	Formats a boolean
String	format(Integer number)	Formats an integer number
String	format(Long number)	Formats a long number
String	format(Number size, FileSizeUnit unit)	Formats a size showing its units
String	format(Object object)	Tests the object type, invoking one of the specific format methods
String	format(BigDecimal number, int scale)	Formats a number with the given scale
String	format(Collection<?> list)	Formats a collection as a comma-separated string, invoking format(Object) for each element
String	format(AccountOwner accountOwner)	Formats an account owner
String	format(ICurrency currency, BigDecimal amount)	Formats an amount with the given currency
String	format(FormattableTimeBasedRate rate)	Formats a time based rate
String	format(IBinaryFile file)	Formats a binary file
String	format(INamedEntity namedEntity)	Formats a named entity
String	format(ICustomFieldPossibleValue<?> possibleValue)	Formats a custom field possible value
String	format(ICustomFieldValue<?,?,?,?> customFieldValue)	Formats a custom field value
String	format(IDynamicFieldValue dynamicValue)	Formats a custom field dynamic value
String	format(IImage image)	Formats an image
String	format(ProfileField profileField)	Formats a user profile field
String	format(HasDisplay hasDisplay)	Formats the given object as the display value
String	format(ICurrencyAmount currencyAmount)	Formats a currency amount
String	format(ICurrencyAmountRange range)	Formats a currency amount range
String	format(IDatePeriod period)	Formats a period
String	format(IDecimalRange range, int scale)	Formats a decimal range with the given scale
String	format(IDimensions dimensions)	Formats a dimensions
String	format(IFileSize fileSize)	Formats a file size
String	format(ILatLong latLong)	Formats a geographical coordinate
String	format(ITimeInterval timeInterval)	Formats a time interval
String	format(Range<?> range)	Formats a range
String	format(HasMessageKey objectWithKey)	Formats an object that has a mapping to the translation message key.
String	format(IDate date)	Formats a date as date and time
String	format(TranslationMessageSpecification tms)	Formats a translation message
String	formatAsDate(IDatePeriod period)	Formats a period as date
String	formatAsDate(IDate dateTime)	Formats an IDate as date
String	formatAsTime(IDate dateTime)	Formats an IDate as time
String	formatAsTimestamp(IDate dateTime)	Formats an IDate as timestamp including the seconds an milliseconds
String	formatDuration(Long duration)	Formats a duration (given in milliseconds) in a string like: 1h 12m 31s
String	formatId(IEntity entity)	Formats the entity identifier
String	formatPercentage(Double number)	Formats a percentage with variable scale
String	formatPercentage(Double number, int scale)	Formats a percentage with the given decimal digits
String	formatPercentage(Integer value, Integer total)	Formats a percentage without decimal fields
String	formatPercentage(Integer value, Integer total, int scale)	Formats a percentage with the given decimal digits
String	formatPercentage(BigDecimal number)	Formats a percentage with variable scale
String	formatPercentage(BigDecimal number, int scale)	Formats a percentage with the given decimal fields
String	formatRelated(AccountVO account)	Formats the account as related to be shown in the result list Used in archived-account-history.html
String	getDatePattern()	Returns the date pattern
String	getTimePattern()	Returns the time pattern

Field Detail

VARIABLE_SCALE

static final int VARIABLE_SCALE

Value used when setting a number format with a custom scale, indicating that the scale is variable. For example, 1 is formatted as 1.0, 1.1 as 1.1, 1.123 as 1.123, etc.

See Also:

Constant Field Values

Method Detail

format

String format(AccountOwner accountOwner)

Formats an account owner

format

String format(BigDecimal number,
              int scale)

Formats a number with the given scale

format

String format(Boolean bool)

Formats a boolean

format

String format(Collection<?> list)

Formats a collection as a comma-separated string, invoking format(Object) for each element

format

String format(FormattableTimeBasedRate rate)

Formats a time based rate

format

String format(HasDisplay hasDisplay)

Formats the given object as the display value

format

String format(HasMessageKey objectWithKey)

Formats an object that has a mapping to the translation message key.

format

String format(IBinaryFile file)

Formats a binary file

format

String format(ICurrency currency,
              BigDecimal amount)

Formats an amount with the given currency

format

String format(ICurrencyAmount currencyAmount)

Formats a currency amount

format

String format(ICurrencyAmountRange range)

Formats a currency amount range

format

String format(ICustomFieldPossibleValue<?> possibleValue)

Formats a custom field possible value

format

String format(ICustomFieldValue<?,?,?,?> customFieldValue)

Formats a custom field value

format

String format(IDate date)

Formats a date as date and time

format

String format(IDatePeriod period)

Formats a period

format

String format(IDecimalRange range,
              int scale)

Formats a decimal range with the given scale

format

String format(IDimensions dimensions)

Formats a dimensions

format

String format(IDynamicFieldValue dynamicValue)

Formats a custom field dynamic value

format

String format(IFileSize fileSize)

Formats a file size

format

String format(IImage image)

Formats an image

format

String format(ILatLong latLong)

Formats a geographical coordinate

format

String format(INamedEntity namedEntity)

Formats a named entity

format

String format(Integer number)

Formats an integer number

format

String format(ITimeInterval timeInterval)

Formats a time interval

format

String format(Long number)

Formats a long number

format

String format(Number size,
              FileSizeUnit unit)

Formats a size showing its units

format

String format(Object object)

Tests the object type, invoking one of the specific format methods

format

String format(ProfileField profileField)

Formats a user profile field

format

String format(Range<?> range)

Formats a range

format

String format(TranslationMessageSpecification tms)

Formats a translation message

formatAsDate

String formatAsDate(IDate dateTime)

Formats an IDate as date

formatAsDate

String formatAsDate(IDatePeriod period)

Formats a period as date

formatAsTime

String formatAsTime(IDate dateTime)

Formats an IDate as time

formatAsTimestamp

String formatAsTimestamp(IDate dateTime)

Formats an IDate as timestamp including the seconds an milliseconds

formatDuration

String formatDuration(Long duration)

Formats a duration (given in milliseconds) in a string like: 1h 12m 31s

formatId

String formatId(IEntity entity)

Formats the entity identifier

formatPercentage

String formatPercentage(BigDecimal number)

Formats a percentage with variable scale

formatPercentage

String formatPercentage(BigDecimal number,
                        int scale)

Formats a percentage with the given decimal fields

formatPercentage

String formatPercentage(Double number)

Formats a percentage with variable scale

formatPercentage

String formatPercentage(Double number,
                        int scale)

Formats a percentage with the given decimal digits

formatPercentage

String formatPercentage(Integer value,
                        Integer total)

Formats a percentage without decimal fields

formatPercentage

String formatPercentage(Integer value,
                        Integer total,
                        int scale)

Formats a percentage with the given decimal digits

formatRelated

String formatRelated(AccountVO account)

Formats the account as related to be shown in the result list Used in archived-account-history.html

getDatePattern

String getDatePattern()

Returns the date pattern

getTimePattern

String getTimePattern()

Returns the time pattern