Class OffsetDateTime

A date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2007-12-03T10:15:30+01:00.

See java.time.OffsetDateTime for full documentation

Hierarchy

  • OffsetDateTime

Constructors

constructor

Methods

adjustInto atZoneSameInstant atZoneSimilarLocal compareTo format get getDayOfMonth getDayOfWeek getDayOfYear getHour getLong getMinute getMonth getMonthValue getNano getOffset getSecond getYear hashCode isAfter isBefore isEqual isSupported minus minusDays minusHours minusMinutes minusMonths minusNanos minusSeconds minusWeeks minusYears plus plusDays plusHours plusMinutes plusMonths plusNanos plusSeconds plusWeeks plusYears query range toEpochSecond toInstant toLocalDate toLocalDateTime toLocalTime toOffsetTime toZonedDateTime truncatedTo until with withDayOfMonth withDayOfYear withHour withMinute withMonth withNano withOffsetSameInstant withOffsetSameLocal withSecond withYear from now of ofInstant parse timeLineOrder

Constructors

constructor

Methods

adjustInto

  • Adjusts the specified temporal object to have the same offset, date and time as this object.

    Parameters

    Returns Temporal

atZoneSameInstant

  • Combines this date-time with a time-zone to create a ZonedDateTime ensuring that the result has the same instant.

    Parameters

    Returns ZonedDateTime

atZoneSimilarLocal

  • Combines this date-time with a time-zone to create a ZonedDateTime trying to keep the same local date and time.

    Parameters

    Returns ZonedDateTime

compareTo

  • Compares this date-time to another date-time.

    Parameters

    Returns number

format

  • Formats this date-time using the specified formatter.

    Parameters

    Returns string

get

  • Gets the value of the specified field from this date-time as an int.

    Parameters

    Returns number

getDayOfMonth

  • Gets the day-of-month field. The first day of the month is 1.

    Returns number

getDayOfWeek

  • Gets the day-of-week field, which is an enum DayOfWeek. Use the method getValue() to extract the numeric value of the day Remember that "Monday" has a getValue of 1, and "Sunday" a getValue of 7

    Returns DayOfWeek

getDayOfYear

  • Gets the day-of-year field. The minimum value of this is 1, and the max is 365 or 366 depending on if it is a leapyear

    Returns number

getHour

  • Gets the hour-of-day field.

    Returns number

getLong

  • Gets the value of the specified field from this date-time as a long.

    Parameters

    Returns number

getMinute

  • Gets the minute-of-hour field.

    Returns number

getMonth

  • Gets the month-of-year field using the Month enum.

    Returns Month

getMonthValue

  • Gets the month-of-year field from 1 to 12.

    Returns number

getNano

  • Gets the nano-of-second field.

    Returns number

getOffset

  • Gets the zone offset, such as '+01:00'.

    Returns ZoneOffset

getSecond

  • Gets the second-of-minute field.

    Returns number

getYear

  • Gets the year field.

    Returns number

hashCode

  • A hash code for this date-time.

    Returns number

isAfter

  • Checks if the instant of this date-time is after that of the specified date-time.

    Parameters

    Returns boolean

isBefore

  • Checks if the instant of this date-time is before that of the specified date-time.

    Parameters

    Returns boolean

isEqual

  • Checks if the instant of this date-time is equal to that of the specified date-time.

    Parameters

    Returns boolean

isSupported

  • Checks if the specified field is supported.

    Parameters

    Returns boolean

  • Checks if the specified unit is supported.

    Parameters

    Returns boolean

minus

  • Returns a copy of this date-time with the specified amount subtracted.

    Parameters

    Returns OffsetDateTime

  • Returns a copy of this date-time with the specified amount subtracted.

    Parameters

    Returns OffsetDateTime

minusDays

  • Returns a copy of this OffsetDateTime with the specified number of days subtracted.

    Parameters

    • days: number

    Returns OffsetDateTime

minusHours

  • Returns a copy of this OffsetDateTime with the specified number of hours subtracted.

    Parameters

    • hours: number

    Returns OffsetDateTime

minusMinutes

  • Returns a copy of this OffsetDateTime with the specified number of minutes subtracted.

    Parameters

    • minutes: number

    Returns OffsetDateTime

minusMonths

  • Returns a copy of this OffsetDateTime with the specified number of months subtracted.

    Parameters

    • months: number

    Returns OffsetDateTime

minusNanos

  • Returns a copy of this OffsetDateTime with the specified number of nanoseconds subtracted.

    Parameters

    • nanos: number

    Returns OffsetDateTime

minusSeconds

  • Returns a copy of this OffsetDateTime with the specified number of seconds subtracted.

    Parameters

    • seconds: number

    Returns OffsetDateTime

minusWeeks

  • Returns a copy of this OffsetDateTime with the specified number of weeks subtracted.

    Parameters

    • weeks: number

    Returns OffsetDateTime

minusYears

  • Returns a copy of this OffsetDateTime with the specified number of years subtracted.

    Parameters

    • years: number

    Returns OffsetDateTime

plus

plusDays

  • Returns a copy of this OffsetDateTime with the specified number of days added.

    Parameters

    • days: number

    Returns OffsetDateTime

plusHours

  • Returns a copy of this OffsetDateTime with the specified number of hours added.

    Parameters

    • hours: number

    Returns OffsetDateTime

plusMinutes

  • Returns a copy of this OffsetDateTime with the specified number of minutes added.

    Parameters

    • minutes: number

    Returns OffsetDateTime

plusMonths

  • Returns a copy of this OffsetDateTime with the specified number of months added.

    Parameters

    • months: number

    Returns OffsetDateTime

plusNanos

  • Returns a copy of this OffsetDateTime with the specified number of nanoseconds added.

    Parameters

    • nanos: number

    Returns OffsetDateTime

plusSeconds

  • Returns a copy of this OffsetDateTime with the specified number of seconds added.

    Parameters

    • seconds: number

    Returns OffsetDateTime

plusWeeks

  • Returns a copy of this OffsetDateTime with the specified number of weeks added.

    Parameters

    • weeks: number

    Returns OffsetDateTime

plusYears

  • Returns a copy of this OffsetDateTime with the specified number of years added.

    Parameters

    • years: number

    Returns OffsetDateTime

query

  • Queries this date-time using the specified query.

    Type Parameters

    • R

    Parameters

    Returns R

range

toEpochSecond

  • Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.

    Returns number

toInstant

  • Converts this date-time to an Instant.

    Returns Instant

toLocalDate

  • Gets the LocalDate part of this date-time.

    Returns LocalDate

toLocalDateTime

toLocalTime

  • Gets the LocalTime part of this date-time.

    Returns LocalTime

toOffsetTime

  • Converts this date-time to an OffsetTime.

    Returns OffsetTime

toZonedDateTime

  • Converts this date-time to a ZonedDateTime using the offset as the zone ID.

    Returns ZonedDateTime

truncatedTo

until

  • Calculates the amount of time until another date-time in terms of the specified unit.

    Parameters

    Returns number

with

withDayOfMonth

  • Returns a copy of this OffsetDateTime with the day-of-month altered.

    Parameters

    • dayOfMonth: number

    Returns OffsetDateTime

withDayOfYear

  • Returns a copy of this OffsetDateTime with the day-of-year altered.

    Parameters

    • dayOfYear: number

    Returns OffsetDateTime

withHour

  • Returns a copy of this OffsetDateTime with the hour-of-day altered.

    Parameters

    • hour: number

    Returns OffsetDateTime

withMinute

  • Returns a copy of this OffsetDateTime with the minute-of-hour altered.

    Parameters

    • minute: number

    Returns OffsetDateTime

withMonth

  • Returns a copy of this OffsetDateTime with the month-of-year altered.

    Parameters

    • month: number

    Returns OffsetDateTime

withNano

  • Returns a copy of this OffsetDateTime with the nano-of-second altered.

    Parameters

    • nanoOfSecond: number

    Returns OffsetDateTime

withOffsetSameInstant

  • Returns a copy of this OffsetDateTime with the specified offset ensuring that the result is at the same instant.

    Parameters

    Returns OffsetDateTime

withOffsetSameLocal

  • Returns a copy of this OffsetDateTime with the specified offset ensuring that the result has the same local date-time.

    Parameters

    Returns OffsetDateTime

withSecond

  • Returns a copy of this OffsetDateTime with the second-of-minute altered.

    Parameters

    • second: number

    Returns OffsetDateTime

withYear

  • Returns a copy of this OffsetDateTime with the year altered.

    Parameters

    • year: number

    Returns OffsetDateTime

Static from

Static now

  • Obtains the current date-time from the system clock in the default time-zone.

    Parameters

    • Optional clockOrZoneId: Clock | ZoneId

      Obtains the current date-time from the specified clock or the system clock in the specified time-zone.

    Returns OffsetDateTime

Static of

  • Obtains an instance of OffsetDateTime from a year, month, day, hour, minute, second, nanosecond and offset.

    Parameters

    • year: number
    • month: number
    • dayOfMonth: number
    • hour: number
    • minute: number
    • second: number
    • nanoOfSecond: number
    • offset: ZoneOffset

    Returns OffsetDateTime

  • Obtains an instance of OffsetDateTime from a date, time and offset.

    Parameters

    Returns OffsetDateTime

  • Obtains an instance of OffsetDateTime from a date-time and offset.

    Parameters

    Returns OffsetDateTime

Static ofInstant

Static parse

  • Obtains an instance of OffsetDateTime from a text string such as 2007-12-03T10:15:30+01:00.

    Parameters

    Returns OffsetDateTime

Static timeLineOrder

  • Gets a function that compares two OffsetDateTime instances based solely on the instant.

    Returns ((o1, o2) => number)

      • (o1, o2): number

      • Gets a function that compares two OffsetDateTime instances based solely on the instant.

        Parameters

        Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc