org.cyclos.utils

Interface Formatter

All Known Implementing Classes:

AbstractFormatter, FormatterImpl

public interface Formatter

Contains methods used to format several types of data

Author:

luis

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format(AccountOwner accountOwner) Formats an account owner
java.lang.String	format(java.math.BigDecimal number, int scale) Formats a number with the given scale
java.lang.String	format(java.lang.Boolean bool) Formats a boolean
java.lang.String	format(java.util.Collection<?> list) Formats a collection as a comma-separated string, invoking format(Object) for each element
java.lang.String	format(DatePeriodDTO period) Formats a period
java.lang.String	format(DateTime dateTime) Formats a dateTime as date and time
java.lang.String	format(FormattableTimeBasedRate rate) Formats a time based rate
java.lang.String	format(HasTransactionNumber htn) Formats an entity with transaction number
java.lang.String	format(ICurrencyAmount currencyAmount) Formats a currency amount
java.lang.String	format(ICustomFieldPossibleValue<?> possibleValue) Formats a custom field possible value
java.lang.String	format(ICustomFieldValue customFieldValue) Formats a custom field value
java.lang.String	format(IDimensions dimensions) Formats a dimensions
java.lang.String	format(IFileSize fileSize) Formats a file size
java.lang.String	format(INamedEntity namedEntity) Formats a named entity
java.lang.String	format(java.lang.Integer number) Formats an integer number
java.lang.String	format(ITimeInterval timeInterval) Formats a time interval
java.lang.String	format(IUser user) Formats an user
java.lang.String	format(java.lang.Long number) Formats a long number
java.lang.String	format(java.lang.Object object) Tests the object type, invoking one of the specific format methods
java.lang.String	format(TranslationMessageSpecification tms) Formats a translation message
java.lang.String	formatAsDate(DatePeriodDTO period) Formats a period as date
java.lang.String	formatAsDate(IDate dateTime) Formats an IDate as date
java.lang.String	formatAsTime(IDate dateTime) Formats an IDate as time
java.lang.String	formatDuration(java.lang.Integer duration) Formats a duration (given in milliseconds) in a string like: 1h 12m 31s
java.lang.String	formatPercentage(java.math.BigDecimal number) Formats a percentage with variable scale
java.lang.String	formatPercentage(java.math.BigDecimal number, int scale) Formats a percentage with the given decimal fields
java.lang.String	formatPercentage(java.lang.Double number) Formats a percentage with variable scale
java.lang.String	formatPercentage(java.lang.Double number, int scale) Formats a percentage with the given decimal digits
java.lang.String	formatPercentage(java.lang.Integer value, java.lang.Integer total) Formats a percentage without decimal fields
java.lang.String	formatPercentage(java.lang.Integer value, java.lang.Integer total, int scale) Formats a percentage with the given decimal digits
java.lang.String	formatVariables(java.lang.String text, java.util.Map<java.lang.String,?> variables) Formats variables in form #name# with values retrieved from the given Map, keyed by the name (without #'s)
java.lang.String	getDatePattern() Returns the date pattern
java.lang.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

java.lang.String format(AccountOwner accountOwner)

Formats an account owner

format

java.lang.String format(java.math.BigDecimal number,
                      int scale)

Formats a number with the given scale

format

java.lang.String format(java.lang.Boolean bool)

Formats a boolean

format

java.lang.String format(java.util.Collection<?> list)

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

format

java.lang.String format(DatePeriodDTO period)

Formats a period

format

java.lang.String format(DateTime dateTime)

Formats a dateTime as date and time

format

java.lang.String format(FormattableTimeBasedRate rate)

Formats a time based rate

format

java.lang.String format(HasTransactionNumber htn)

Formats an entity with transaction number

format

java.lang.String format(ICurrencyAmount currencyAmount)

Formats a currency amount

format

java.lang.String format(ICustomFieldPossibleValue<?> possibleValue)

Formats a custom field possible value

format

java.lang.String format(ICustomFieldValue customFieldValue)

Formats a custom field value

format

java.lang.String format(IDimensions dimensions)

Formats a dimensions

format

java.lang.String format(IFileSize fileSize)

Formats a file size

format

java.lang.String format(INamedEntity namedEntity)

Formats a named entity

format

java.lang.String format(java.lang.Integer number)

Formats an integer number

format

java.lang.String format(ITimeInterval timeInterval)

Formats a time interval

format

java.lang.String format(IUser user)

Formats an user

format

java.lang.String format(java.lang.Long number)

Formats a long number

format

java.lang.String format(java.lang.Object object)

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

format

java.lang.String format(TranslationMessageSpecification tms)

Formats a translation message

formatAsDate

java.lang.String formatAsDate(DatePeriodDTO period)

Formats a period as date

formatAsDate

java.lang.String formatAsDate(IDate dateTime)

Formats an IDate as date

formatAsTime

java.lang.String formatAsTime(IDate dateTime)

Formats an IDate as time

formatDuration

java.lang.String formatDuration(java.lang.Integer duration)

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

formatPercentage

java.lang.String formatPercentage(java.math.BigDecimal number)

Formats a percentage with variable scale

formatPercentage

java.lang.String formatPercentage(java.math.BigDecimal number,
                                int scale)

Formats a percentage with the given decimal fields

formatPercentage

java.lang.String formatPercentage(java.lang.Double number)

Formats a percentage with variable scale

formatPercentage

java.lang.String formatPercentage(java.lang.Double number,
                                int scale)

Formats a percentage with the given decimal digits

formatPercentage

java.lang.String formatPercentage(java.lang.Integer value,
                                java.lang.Integer total)

Formats a percentage without decimal fields

formatPercentage

java.lang.String formatPercentage(java.lang.Integer value,
                                java.lang.Integer total,
                                int scale)

Formats a percentage with the given decimal digits

formatVariables

java.lang.String formatVariables(java.lang.String text,
                               java.util.Map<java.lang.String,?> variables)

Formats variables in form #name# with values retrieved from the given Map, keyed by the name (without #'s)

getDatePattern

java.lang.String getDatePattern()

Returns the date pattern

getTimePattern

java.lang.String getTimePattern()

Returns the time pattern