Class MediaTimeFormatter

java.lang.Object
ca.phon.formatter.MediaTimeFormatter
All Implemented Interfaces:
Formatter<Number>
@FormatterType(Number.class) public class MediaTimeFormatter extends Object implements Formatter<Number>
Media time formatter with three formats as defined by MediaTimeFormatStyle

  • Constructor Details

    • MediaTimeFormatter

      public MediaTimeFormatter()

    • MediaTimeFormatter

      public MediaTimeFormatter(MediaTimeFormatStyle formatStyle)

  • Method Details

    • timeToMinutesAndSeconds

      public static String timeToMinutesAndSeconds(Number number)
      Return time in minutes and seconds (short form: e.g., 1:3.5)
      Parameters:
      number - if number is a float time is interpreted as a values in seconds, milliseconds otherwise
      Returns:
      formatted time value

    • secondsToMinutesAndSeconds

      public static String secondsToMinutesAndSeconds(Number seconds)
      Convert seconds to string in minutes and seconds (short form: e.g., 1:3.5)
      Parameters:
      seconds - time value in seconds
      Returns:
      formatted time value

    • msToMinutesAndSeconds

      public static String msToMinutesAndSeconds(Number ms)
      Convert milliseconds to string in minutes and seconds (short form: e.g., 1:3.5)
      Parameters:
      ms - time value in seconds
      Returns:
      formatted time value

    • timeToPaddedMinutesAndSeconds

      public static String timeToPaddedMinutesAndSeconds(Number number)
      Return time in minutes and seconds (long form: e.g., 001:03.05)
      Parameters:
      number - if number is a float time is interpreted as a values in seconds, milliseconds otherwise
      Returns:
      formatted time value

    • secondsToPaddedMinutesAndSeconds

      public static String secondsToPaddedMinutesAndSeconds(Number seconds)
      Return seconds in minutes and seconds (long form: e.g., 001:03.05)
      Parameters:
      seconds - time in seconds
      Returns:
      formatted time value

    • msToPaddedMinutesAndSeconds

      public static String msToPaddedMinutesAndSeconds(Number ms)
      Return milliseconds in minutes and seconds (long form: e.g., 001:03.05)
      Parameters:
      ms - time in milliseconds
      Returns:
      formatted time value

    • timeToMilliseconds

      public static String timeToMilliseconds(Number number)
      Return time in milliseconds (integer)
      Parameters:
      number - if number is a float time is interpreted as a values in seconds, milliseconds otherwise
      Returns:
      formatted time value

    • secondsToMilliseconds

      public static String secondsToMilliseconds(Number seconds)
      Return time in milliseconds (integer)
      Parameters:
      seconds - time in seconds
      Returns:
      formatted time value

    • msToMilliseconds

      public static String msToMilliseconds(Number ms)
      Return time in milliseconds (integer)
      Parameters:
      ms - time in milliseconds
      Returns:
      formatted time value

    • timeToString

      public static String timeToString(Number number, MediaTimeFormatStyle formatStyle)
      Return formmated string of given number
      Parameters:
      number - if number is a float time is interpreted as a values in seconds, milliseconds otherwise
      formatStyle -
      Returns:
      formatted time string

    • parseTimeToSeconds

      public static float parseTimeToSeconds(String text) throws ParseException
      Parse time to a number of seconds
      Parameters:
      text -
      Returns:
      number of seconds
      Throws:
      ParseException

    • parseTimeToMilliseconds

      public static long parseTimeToMilliseconds(String text) throws ParseException
      Parse time to a number of milliseconds
      Parameters:
      text -
      Returns:
      number of milliseconds
      Throws:
      ParseException

    • format

      public String format(Number obj)
      Description copied from interface: Formatter
      Convert the given object into a formatted String.
      Specified by:
      format in interface Formatter<Number>
      Parameters:
      obj -
      Returns:
      formatted string

    • parse

      public Number parse(String text) throws ParseException
      Description copied from interface: Formatter
      Parse the given string into a new object instance
      Specified by:
      parse in interface Formatter<Number>
      Parameters:
      text -
      Returns:
      parsed object
      Throws:
      ParseException - if there was a problem parsing the given text