Package com.inductiveautomation.ignition.common

Class FormatUtil

  • public class FormatUtil
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.regex.Pattern EMAIL_PATTERN  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean customToString​(java.lang.Throwable ex)
      Returns true if the given throwable uses a custom implementation of toString()
      static java.lang.String formatByteSize​(long numBytes)
      Formats a size of bytes, appropriately rounding to bytes, kb, mb, etc
      static java.lang.String formatDateFull​(java.util.Date value)
      Returns a date formated to yyyy-MM-dd hh:mm:ss.S
      static java.lang.String formatDuration​(long millis)
      Formats a number of milliseconds as a human-readable string, like "5 hours, 35 minutes, 28 seconds"
      static java.lang.String formatDuration​(long millis, FormatUtil.DurationFormatStyle style)  
      static java.lang.String formatDuration​(java.util.Locale locale, long millis)
      Formats a number of milliseconds as a human-readable string, like "5 hours, 35 minutes, 28 seconds"
      static java.lang.String formatDuration​(java.util.Locale locale, long millis, FormatUtil.DurationFormatStyle style)  
      static java.lang.String formatDuration​(java.util.Locale locale, long millis, FormatUtil.DurationFormatStyle style, boolean alwaysShowMillis)  
      static java.lang.String formatDurationSince​(long millisStart)
      Shortcut, equivalent to formatDuration(System.currentTimeMillis()-millisStart)
      static java.lang.String formatDurationSince​(long millisStart, FormatUtil.DurationFormatStyle style)  
      static java.lang.String formatDurationSinceNano​(long nanoStart)
      Convenience function for using nanoTime for diffs.
      static java.lang.String formatSafe​(java.lang.String value, java.lang.Object... formatArgs)
      Performs String.format() on the value, with the provided args, but catches the IllegalFormatException that the function might throw.
      static java.lang.String formatSafe​(org.apache.log4j.Logger log, java.lang.String value, java.lang.Object... formatArgs)
      Performs String.format() on the value, with the provided args, but catches the IllegalFormatException that the function might throw.
      static java.text.DecimalFormat getCurrencyInstance​(java.util.Locale locale)  
      static java.text.DecimalFormat getDecimalFormat​(java.lang.String pattern)
      Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard.
      static java.text.DecimalFormat getDecimalFormat​(java.lang.String pattern, java.util.Locale locale)
      Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard.
      static java.text.DecimalFormatSymbols getDecimalFormatSymbols()
      Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard.
      static java.text.DecimalFormatSymbols getDecimalFormatSymbols​(java.util.Locale locale)
      Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard.
      static java.text.DecimalFormat getIntegerInstance​(java.util.Locale locale)  
      static java.text.DecimalFormat getNumberInstance​(java.util.Locale locale)  
      static java.text.DecimalFormat getPercentInstance​(java.util.Locale locale)  
      static java.lang.String getStacktraceCompact​(java.lang.Throwable ex)  
      static java.lang.String getStacktraceFull​(java.lang.Throwable ex)  
      static boolean isValidEmailFormat​(java.lang.String email)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • EMAIL_PATTERN

        public static final java.util.regex.Pattern EMAIL_PATTERN

    • Method Detail

      • formatByteSize

        public static java.lang.String formatByteSize​(long numBytes)
        Formats a size of bytes, appropriately rounding to bytes, kb, mb, etc

      • formatDurationSince

        public static java.lang.String formatDurationSince​(long millisStart)
        Shortcut, equivalent to formatDuration(System.currentTimeMillis()-millisStart)

      • formatDurationSinceNano

        public static java.lang.String formatDurationSinceNano​(long nanoStart)
        Convenience function for using nanoTime for diffs. Note, however, that internally the value is converted to milliseconds, so this is not useful for formatting sub-millisecond values.

      • formatDuration

        public static java.lang.String formatDuration​(long millis)
        Formats a number of milliseconds as a human-readable string, like "5 hours, 35 minutes, 28 seconds"

      • formatDuration

        public static java.lang.String formatDuration​(java.util.Locale locale,
                                              long millis)
        Formats a number of milliseconds as a human-readable string, like "5 hours, 35 minutes, 28 seconds"

      • formatDuration

        public static java.lang.String formatDuration​(java.util.Locale locale,
                                              long millis,
                                              FormatUtil.DurationFormatStyle style,
                                              boolean alwaysShowMillis)

      • customToString

        public static boolean customToString​(java.lang.Throwable ex)
        Returns true if the given throwable uses a custom implementation of toString()

      • getStacktraceCompact

        public static java.lang.String getStacktraceCompact​(java.lang.Throwable ex)

      • getStacktraceFull

        public static java.lang.String getStacktraceFull​(java.lang.Throwable ex)

      • formatDateFull

        public static java.lang.String formatDateFull​(java.util.Date value)
        Returns a date formated to yyyy-MM-dd hh:mm:ss.S

      • formatSafe

        public static java.lang.String formatSafe​(java.lang.String value,
                                          java.lang.Object... formatArgs)
        Performs String.format() on the value, with the provided args, but catches the IllegalFormatException that the function might throw. If formatArgs is null, no operation is performed and the value is returned.

      • formatSafe

        public static java.lang.String formatSafe​(@Nullable
                                          org.apache.log4j.Logger log,
                                          @Nullable
                                          java.lang.String value,
                                          @Nullable
                                          java.lang.Object... formatArgs)
        Performs String.format() on the value, with the provided args, but catches the IllegalFormatException that the function might throw. If formatArgs is null, no operation is performed and the value is returned. If the logger parameter is not null, a warning will be logged if an error occurs.

      • getDecimalFormatSymbols

        public static java.text.DecimalFormatSymbols getDecimalFormatSymbols()
        Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard. This overrides to the much more common symbol. This method should _always_ be used instead of getting a instance directly. See FB14239

        Also, do not hang on to an instance of dfs if the locale could have changed between uses. Get a new set each time.

        Returns:
        DecimalFormatSymbols for the default locale, with appropriate changes

      • getDecimalFormatSymbols

        public static java.text.DecimalFormatSymbols getDecimalFormatSymbols​(java.util.Locale locale)
        Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard. This overrides to the much more common symbol. This method should _always_ be used instead of getting a instance directly. See FB14239
        Returns:
        DecimalFormatSymbols for the given locale, with appropriate changes

      • getDecimalFormat

        public static java.text.DecimalFormat getDecimalFormat​(java.lang.String pattern)
        Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard. This overrides to the much more common symbol. This method should _always_ be used instead of getting a instance directly. See FB14239

        Also, do not hang on to an instance of DecimalFormat if the locale could have changed between uses. Get a new instance each time.

        Parameters:
        pattern - Format pattern
        Returns:
        DecimalFormat with appropriate symbol changes for the default locale. Not null.

      • getDecimalFormat

        public static java.text.DecimalFormat getDecimalFormat​(java.lang.String pattern,
                                                       java.util.Locale locale)
        Java 9 changed how format symbols are searched, which causes issues for some locales: the symbol returned doesn't match what the user will typically enter from their keyboard. This overrides to the much more common symbol. This method should _always_ be used instead of getting a instance directly. See FB14239

        Also, do not hang on to an instance of DecimalFormat if the locale could have changed between uses. Get a new instance each time.

        Parameters:
        pattern - Format pattern
        locale - Locale for formatting
        Returns:
        DecimalFormat with appropriate symbol changes for the given locale. Not null.

      • getIntegerInstance

        public static java.text.DecimalFormat getIntegerInstance​(java.util.Locale locale)

      • getCurrencyInstance

        public static java.text.DecimalFormat getCurrencyInstance​(java.util.Locale locale)

      • getNumberInstance

        public static java.text.DecimalFormat getNumberInstance​(java.util.Locale locale)

      • getPercentInstance

        public static java.text.DecimalFormat getPercentInstance​(java.util.Locale locale)

      • isValidEmailFormat

        public static boolean isValidEmailFormat​(java.lang.String email)