Class StringFormatter

java.lang.Object
org.eclipse.birt.core.format.StringFormatter
All Implemented Interfaces:
IFormatter

public class StringFormatter extends Object implements IFormatter
Defines a string formatting class. Notice that unlike numeric or Date formatting, locale is irrelevant in string formatting
  • Field Details

    • logger

      protected static Logger logger
      logger used to log syntax errors.
    • formatPattern

      protected String 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 public StringFormatter(Locale locale)
      Deprecated.
      since 2.1
    • StringFormatter

      public StringFormatter(String format)
      constructor with a format string argument
      Parameters:
      format - the format string
    • StringFormatter

      public StringFormatter(String format, com.ibm.icu.util.ULocale locale)
      Constructor with the format string and locale
      Parameters:
      format - the format string
      locale - the locale
    • StringFormatter

      @Deprecated public StringFormatter(String format, Locale locale)
      Deprecated.
      since 2.1
  • Method Details

    • applyPattern

      public void applyPattern(String format)
      Parameters:
      format - the format pattern
    • getPattern

      public String getPattern()
      returns the original format string.
    • getULocale

      public com.ibm.icu.util.ULocale getULocale()
      getLoacle() method, return the locale value.
    • getLocale

      @Deprecated public Locale getLocale()
      Deprecated.
      since 2.1
      Returns:
    • setLocale

      public void setLocale(com.ibm.icu.util.ULocale theLocale)
      setLoacle() method, set the locale value.
    • setLocale

      @Deprecated public void setLocale(Locale theLocale)
      Deprecated.
      since 2.1
    • format

      public String format(String str)
      returns the formated string for the string parameter.
    • '@' - character or space
    • '&' - character or empty
    • '<' - tolower
    • '>' - toupper
    • '!' - left to right
    • Parameters:
      str - format string
    • parser

      public String parser(String str) throws ParseException
      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

      public String formatValue(Object value)
      Description copied from interface: IFormatter
      format the value object into a string.
      Specified by:
      formatValue in interface IFormatter
      Returns: