Package org.elasticsearch.common.time

Interface DateFormatter

All Known Implementing Classes:
JodaDateFormatter
public interface DateFormatter

  • Method Summary

    Modifier and Type Method Description
    java.lang.String format​(java.time.temporal.TemporalAccessor accessor)
    Print the supplied java time accessor in a string based representation according to this formatter
    default java.lang.String formatJoda​(org.joda.time.DateTime dateTime)
    Return the given Joda DateTime formatted with this format.
    default java.lang.String formatMillis​(long millis)
    Return the given millis-since-epoch formatted with this format.
    static DateFormatter forPattern​(java.lang.String input)  
    java.util.Locale locale()
    Returns the configured locale of the date formatter
    java.time.temporal.TemporalAccessor parse​(java.lang.String input)
    Try to parse input to a java time TemporalAccessor
    default org.joda.time.DateTime parseJoda​(java.lang.String input)
    Parse the given input into a Joda DateTime.
    default long parseMillis​(java.lang.String input)
    Parse the given input into millis-since-epoch.
    java.lang.String pattern()
    A name based format for this formatter.
    static java.util.List<java.lang.String> splitCombinedPatterns​(java.lang.String input)  
    static java.lang.String strip8Prefix​(java.lang.String input)  
    DateMathParser toDateMathParser()
    Create a DateMathParser from the existing formatter
    DateFormatter withLocale​(java.util.Locale locale)
    Create a copy of this formatter that is configured to parse dates in the specified locale
    DateFormatter withZone​(java.time.ZoneId zoneId)
    Create a copy of this formatter that is configured to parse dates in the specified time zone
    java.time.ZoneId zone()
    Returns the configured time zone of the date formatter

  • Method Details

    • parse

      java.time.temporal.TemporalAccessor parse​(java.lang.String input)
      Try to parse input to a java time TemporalAccessor
      Parameters:
      input - An arbitrary string resembling the string representation of a date or time
      Returns:
      The java time object containing the parsed input
      Throws:
      java.time.format.DateTimeParseException - If parsing fails, this exception will be thrown. Note that it can contained suppressed exceptions when several formatters failed parse this value

    • parseMillis

      default long parseMillis​(java.lang.String input)
      Parse the given input into millis-since-epoch.

    • parseJoda

      default org.joda.time.DateTime parseJoda​(java.lang.String input)
      Parse the given input into a Joda DateTime.

    • withZone

      DateFormatter withZone​(java.time.ZoneId zoneId)
      Create a copy of this formatter that is configured to parse dates in the specified time zone
      Parameters:
      zoneId - The time zone to act on
      Returns:
      A copy of the date formatter this has been called on

    • withLocale

      DateFormatter withLocale​(java.util.Locale locale)
      Create a copy of this formatter that is configured to parse dates in the specified locale
      Parameters:
      locale - The local to use for the new formatter
      Returns:
      A copy of the date formatter this has been called on

    • format

      java.lang.String format​(java.time.temporal.TemporalAccessor accessor)
      Print the supplied java time accessor in a string based representation according to this formatter
      Parameters:
      accessor - The temporal accessor used to format
      Returns:
      The string result for the formatting

    • formatMillis

      default java.lang.String formatMillis​(long millis)
      Return the given millis-since-epoch formatted with this format.

    • formatJoda

      default java.lang.String formatJoda​(org.joda.time.DateTime dateTime)
      Return the given Joda DateTime formatted with this format.

    • pattern

      java.lang.String pattern()
      A name based format for this formatter. Can be one of the registered formatters like epoch_millis or a configured format like HH:mm:ss
      Returns:
      The name of this formatter

    • locale

      java.util.Locale locale()
      Returns the configured locale of the date formatter
      Returns:
      The locale of this formatter

    • zone

      java.time.ZoneId zone()
      Returns the configured time zone of the date formatter
      Returns:
      The time zone of this formatter

    • toDateMathParser

      DateMathParser toDateMathParser()
      Create a DateMathParser from the existing formatter
      Returns:
      The DateMathParser object

    • forPattern

      static DateFormatter forPattern​(java.lang.String input)

    • strip8Prefix

      static java.lang.String strip8Prefix​(java.lang.String input)

    • splitCombinedPatterns

      static java.util.List<java.lang.String> splitCombinedPatterns​(java.lang.String input)