Package org.eclipse.birt.core.format
Class StringFormatter
java.lang.Object
org.eclipse.birt.core.format.StringFormatter
- All Implemented Interfaces:
IFormatter
Defines a string formatting class. Notice that unlike numeric or Date
formatting, locale is irrelevant in string formatting
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.birt.core.format.IFormatter
IFormatter.DefaultFormatter -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionconstructor with no argumentStringFormatter(com.ibm.icu.util.ULocale locale) constructor with no formatting stringStringFormatter(String format) constructor with a format string argumentStringFormatter(String format, com.ibm.icu.util.ULocale locale) Constructor with the format string and localeStringFormatter(String format, Locale locale) Deprecated.since 2.1StringFormatter(Locale locale) Deprecated.since 2.1 -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyPattern(String format) returns the formated string for the string parameter.formatValue(Object value) format the value object into a string.Deprecated.since 2.1returns the original format string.com.ibm.icu.util.ULocalegetLoacle() method, return the locale value.Parses the input string into a unformatted string type.voidsetLocale(com.ibm.icu.util.ULocale theLocale) setLoacle() method, set the locale value.voidDeprecated.since 2.1voidsetTrim(boolean trim)
-
Field Details
-
logger
logger used to log syntax errors. -
formatPattern
-
-
Constructor Details
-
StringFormatter
public StringFormatter()constructor with no argument -
StringFormatter
public StringFormatter(com.ibm.icu.util.ULocale locale) constructor with no formatting string -
StringFormatter
Deprecated.since 2.1 -
StringFormatter
constructor with a format string argument- Parameters:
format- the format string
-
StringFormatter
Constructor with the format string and locale- Parameters:
format- the format stringlocale- the locale
-
StringFormatter
Deprecated.since 2.1
-
-
Method Details
-
applyPattern
- Parameters:
format- the format pattern
-
getPattern
returns the original format string. -
getULocale
public com.ibm.icu.util.ULocale getULocale()getLoacle() method, return the locale value. -
getLocale
Deprecated.since 2.1- Returns:
-
setLocale
public void setLocale(com.ibm.icu.util.ULocale theLocale) setLoacle() method, set the locale value. -
setLocale
Deprecated.since 2.1 -
format
returns the formated string for the string parameter.- '@' - character or space
- '&' - character or empty
- '<' - tolower
- '>' - toupper
- '!' - left to right
- Parameters:
str- format string
-
parser
Parses the input string into a unformatted string type.- Parameters:
str- the input string to parse- Returns:
- the string
- Throws:
ParseException- if the specified string cannot be parsed according to specified pattern.
-
setTrim
public void setTrim(boolean trim) - Parameters:
trim- the trim to set
-
formatValue
Description copied from interface:IFormatterformat the value object into a string.- Specified by:
formatValuein interfaceIFormatter- Returns:
-