OffsetDateTime (Groovy JDK enhancements)

Package: java.time

## Class OffsetDateTime

- - ### Methods Summary

    Methods
    Return type | Name and parameters
    --- | ---
    `OffsetDateTime` | `clearTime()` Returns an OffsetDateTime with the time portion cleared.
    `String` | `format(String pattern)` Formats this date/time with the provided DateTimeFormatter pattern.
    `String` | `format(FormatStyle dateTimeStyle)` Formats this date/time in the provided, localized FormatStyle.
    `String` | `getDateString()` Formats this date/time with the DateTimeFormatter#ISO_OFFSET_DATE formatter.
    `String` | `getDateTimeString()` Formats this date/time with the DateTimeFormatter#ISO_OFFSET_DATE_TIME formatter.
    `String` | `getTimeString()` Formats this date/time with the DateTimeFormatter#ISO_OFFSET_TIME formatter.
    `OffsetDateTime` | `minus(long seconds)` Returns an OffsetDateTime that is `seconds` seconds before this date/time.
    `OffsetDateTime` | `next()` Returns an OffsetDateTime one second after this date/time.
    `OffsetDateTime` | `parse(CharSequence text, String pattern)` Parse text into an OffsetDateTime using the provided pattern.
    `OffsetDateTime` | `plus(long seconds)` Returns an OffsetDateTime that is `seconds` seconds after this date/time.
    `OffsetDateTime` | `previous()` Returns an OffsetDateTime one second before this date/time.
    `Calendar` | `toCalendar()` Returns a generally equivalent instance of Calendar.
    `Date` | `toDate()` Returns a generally equivalent instance of Date.

  - #### Methods inherited from class java.lang.Object

    `addShutdownHook`, `any`, `any`, `asBoolean`, `asType`, `average`, `collect`, `collect`, `collect`, `contains`, `count`, `dump`, `each`, `eachWithIndex`, `equals`, `every`, `every`, `find`, `find`, `findAll`, `findAll`, `findIndexOf`, `findIndexOf`, `findIndexValues`, `findIndexValues`, `findLastIndexOf`, `findLastIndexOf`, `findResult`, `findResult`, `flatten`, `getAt`, `getMetaClass`, `getMetaPropertyValues`, `getProperties`, `grep`, `grep`, `groupBy`, `groupBy`, `hasProperty`, `identity`, `inject`, `inject`, `inspect`, `invokeMethod`, `is`, `isCase`, `iterator`, `join`, `metaClass`, `print`, `print`, `printf`, `printf`, `println`, `println`, `println`, `putAt`, `respondsTo`, `respondsTo`, `setMetaClass`, `size`, `split`, `sprintf`, `sprintf`, `stream`, `sum`, `sum`, `tap`, `toArrayString`, `toSpreadMap`, `toString`, `use`, `use`, `use`, `with`, `with`, `withTraits`

  - #### Methods inherited from interface java.lang.Comparable

    `numberAwareCompareTo`

  - #### Methods inherited from interface java.time.temporal.Temporal

    `downto`, `downto`, `rightShift`, `upto`, `upto`

  - #### Methods inherited from interface java.time.temporal.TemporalAccessor

    `getAt`

- - ### Methods Detail

    - #### public OffsetDateTime clearTime()

      Returns an OffsetDateTime with the time portion cleared.

      Returns:
        an OffsetDateTime
      Since:
        2.5.0

    - #### public String format(String pattern)

      Formats this date/time with the provided DateTimeFormatter pattern.

      Parameters:
        `pattern` - the formatting pattern
      Returns:
        a formatted String
      Since:
        2.5.0
      See Also:
        DateTimeFormatter

    - #### public String format(FormatStyle dateTimeStyle)

      Formats this date/time in the provided, localized FormatStyle.

      Parameters:
        `dateTimeStyle` - the FormatStyle
      Returns:
        a formatted String
      Since:
        2.5.0
      See Also:
        DateTimeFormatter

    - #### public String getDateString()

      Formats this date/time with the DateTimeFormatter#ISO_OFFSET_DATE formatter.

      Returns:
        a formatted String
      Since:
        2.5.0
      See Also:
        DateTimeFormatter

    - #### public String getDateTimeString()

      Formats this date/time with the DateTimeFormatter#ISO_OFFSET_DATE_TIME formatter.

      Returns:
        a formatted String
      Since:
        2.5.0
      See Also:
        DateTimeFormatter

    - #### public String getTimeString()

      Formats this date/time with the DateTimeFormatter#ISO_OFFSET_TIME formatter.

      Returns:
        a formatted String
      Since:
        2.5.0
      See Also:
        DateTimeFormatter

    - #### public OffsetDateTime minus(long seconds)

      Returns an OffsetDateTime that is `seconds` seconds before this date/time.

      Parameters:
        `seconds` - the number of seconds to subtract
      Returns:
        an OffsetDateTime
      Since:
        2.5.0

    - #### public OffsetDateTime next()

      Returns an OffsetDateTime one second after this date/time.

      Returns:
        an OffsetDateTime
      Since:
        2.5.0

    - #### public OffsetDateTime parse(CharSequence text, String pattern)

      Parse text into an OffsetDateTime using the provided pattern.

      Parameters:
        `text` - String to be parsed to create the date instance
        `pattern` - pattern used to parse the text
      Returns:
        an OffsetDateTime representing the parsed text
      Since:
        2.5.0
      See Also:
        DateTimeFormatter
        OffsetDateTime#parse(java.lang.CharSequence, java.time.format.DateTimeFormatter)

    - #### public OffsetDateTime plus(long seconds)

      Returns an OffsetDateTime that is `seconds` seconds after this date/time.

      Parameters:
        `seconds` - the number of seconds to add
      Returns:
        an OffsetDateTime
      Since:
        2.5.0

    - #### public OffsetDateTime previous()

      Returns an OffsetDateTime one second before this date/time.

      Returns:
        an OffsetDateTime
      Since:
        2.5.0

    - #### public Calendar toCalendar()

      Returns a generally equivalent instance of Calendar. The time value of the returned calendar is truncated to milliseconds and the time zone is based on the offset of this date/time.

      Returns:
        a java.util.Calendar
      Since:
        2.5.0

    - #### public Date toDate()

      Returns a generally equivalent instance of Date. The time value of the returned date is truncated to milliseconds and will be adjusted to the current system default time zone.

      Returns:
        a java.util.Date
      Since:
        2.5.0