jdk.time.chrono.ChronoZonedDateTime — clojure-interop/java.time 1.0.5

A date-time with a time-zone in an arbitrary chronology, intended for advanced globalization use cases.

Most applications should declare method signatures, fields and variables as ZonedDateTime, not this interface.

A ChronoZonedDateTime is the abstract representation of an offset date-time where the Chronology chronology, or calendar system, is pluggable. The date-time is defined in terms of fields expressed by TemporalField, where most common implementations are defined in ChronoField. The chronology defines how the calendar system operates and the meaning of the standard fields.

When to use this interface The design of the API encourages the use of ZonedDateTime rather than this interface, even in the case where the application needs to deal with multiple calendar systems. The rationale for this is explored in detail in ChronoLocalDate.

Ensure that the discussion in ChronoLocalDate has been read and understood before using this interface.

*from clj

(*from temporal)

Obtains an instance of ChronoZonedDateTime from a temporal object.

This creates a zoned date-time based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ChronoZonedDateTime.

The conversion extracts and combines the chronology, date, time and zone from the temporal object. The behavior is equivalent to using Chronology.zonedDateTime(TemporalAccessor) with the extracted chronology. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, ChronoZonedDateTime::from.

temporal - the temporal object to convert, not null - java.time.temporal.TemporalAccessor

returns: the date-time, not null - java.time.chrono.ChronoZonedDateTime<?>

throws: java.time.DateTimeException - if unable to convert to a ChronoZonedDateTime

*time-line-order clj

(*time-line-order)

Gets a comparator that compares ChronoZonedDateTime in time-line order ignoring the chronology.

This comparator differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>) in that it only compares the underlying instant and not the chronology. This allows dates in different calendar systems to be compared based on the position of the date-time on the instant time-line. The underlying comparison is equivalent to comparing the epoch-second and nano-of-second.

returns: a comparator that compares in time-line order ignoring the chronology - java.util.Comparator<java.time.chrono.ChronoZonedDateTime<?>>

compare-to clj

(compare-to this other)

Compares this date-time to another date-time, including the chronology.

The comparison is based first on the instant, then on the local date-time, then on the zone ID, then on the chronology. It is "consistent with equals", as defined by Comparable.

If all the date-time objects being compared are in the same chronology, then the additional chronology stage is not required.

This default implementation performs the comparison defined above.

other - the other date-time to compare to, not null - java.time.chrono.ChronoZonedDateTime

returns: the comparator value, negative if less, positive if greater - default int

equals clj

(equals this obj)

Checks if this date-time is equal to another date-time.

The comparison is based on the offset date-time and the zone. To compare for the same instant on the time-line, use compareTo(java.time.chrono.ChronoZonedDateTime<?>). Only objects of type ChronoZonedDateTime are compared, other types return false.

obj - the object to check, null returns false - java.lang.Object

returns: true if this is equal to the other date-time - boolean

format clj

(format this formatter)

Formats this date-time using the specified formatter.

This date-time will be passed to the formatter to produce a string.

The default implementation must behave as follows:

return formatter.format(this);

formatter - the formatter to use, not null - java.time.format.DateTimeFormatter

returns: the formatted date-time string, not null - default java.lang.String

throws: java.time.DateTimeException - if an error occurs during printing

get clj

(get this field)

Description copied from interface: TemporalAccessor

field - the field to get, not null - java.time.temporal.TemporalField

returns: the value for the field, within the valid range of values - default int

get-chronology clj

(get-chronology this)

Gets the chronology of this date-time.

The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.

returns: the chronology, not null - default java.time.chrono.Chronology

get-long clj

(get-long this field)

Description copied from interface: TemporalAccessor

field - the field to get, not null - java.time.temporal.TemporalField

returns: the value for the field - default long

get-offset clj

(get-offset this)

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

This is the offset of the local date-time from UTC/Greenwich.

returns: the zone offset, not null - java.time.ZoneOffset

get-zone clj

(get-zone this)

Gets the zone ID, such as 'Europe/Paris'.

This returns the stored time-zone id used to determine the time-zone rules.

returns: the zone ID, not null - java.time.ZoneId

hash-code clj

(hash-code this)

A hash code for this date-time.

returns: a suitable hash code - int

is-after clj

(is-after this other)

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

This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>) in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isAfter(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

other - the other date-time to compare to, not null - java.time.chrono.ChronoZonedDateTime

returns: true if this is after the specified date-time - default boolean

is-before clj

(is-before this other)

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

This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>) in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isBefore(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

other - the other date-time to compare to, not null - java.time.chrono.ChronoZonedDateTime

returns: true if this point is before the specified date-time - default boolean

is-equal clj

(is-equal this other)

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

This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>) and equals(java.lang.Object) in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().equals(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

other - the other date-time to compare to, not null - java.time.chrono.ChronoZonedDateTime

returns: true if the instant equals the instant of the specified date-time - default boolean

minus clj

(minus this amount)

(minus this amount-to-subtract unit)

Returns an object of the same type as this object with the specified period subtracted.

This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

amount-to-subtract - the amount of the specified unit to subtract, may be negative - long unit - the unit of the amount to subtract, not null - java.time.temporal.TemporalUnit

returns: an object of the same type with the specified period subtracted, not null - default java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if the unit cannot be subtracted

plus clj

(plus this amount)

(plus this amount-to-add unit)

Returns an object of the same type as this object with the specified period added.

This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

amount-to-add - the amount of the specified unit to add, may be negative - long unit - the unit of the amount to add, not null - java.time.temporal.TemporalUnit

returns: an object of the same type with the specified period added, not null - java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if the unit cannot be added

query clj

(query this query)

Queries this date-time using the specified query.

This queries this date-time using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

The result of this method is obtained by invoking the TemporalQuery.queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

query - the query to invoke, not null - java.time.temporal.TemporalQuery

returns: the query result, null may be returned (defined by the query) - default <R> R

throws: java.time.DateTimeException - if unable to query (defined by the query)

range clj

(range this field)

Description copied from interface: TemporalAccessor

field - the field to query the range for, not null - java.time.temporal.TemporalField

returns: the range of valid values for the field, not null - default java.time.temporal.ValueRange

supported? clj

(supported? this field)

Checks if the specified field is supported.

This checks if the specified field can be queried on this date-time. If false, then calling the range, get and with(TemporalField, long) methods will throw an exception.

The set of supported fields is defined by the chronology and normally includes all ChronoField fields.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

field - the field to check, null returns false - java.time.temporal.TemporalField

returns: true if the field can be queried, false if not - boolean

to-epoch-second clj

(to-epoch-second this)

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

This uses the local date-time and offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.

returns: the number of seconds from the epoch of 1970-01-01T00:00:00Z - default long

to-instant clj

(to-instant this)

Converts this date-time to an Instant.

This returns an Instant representing the same point on the time-line as this date-time. The calculation combines the local date-time and offset.

returns: an Instant representing the same instant, not null - default java.time.Instant

to-local-date clj

(to-local-date this)

Gets the local date part of this date-time.

This returns a local date with the same year, month and day as this date-time.

returns: the date part of this date-time, not null - default D

to-local-date-time clj

(to-local-date-time this)

Gets the local date-time part of this date-time.

This returns a local date with the same year, month and day as this date-time.

returns: the local date-time part of this date-time, not null - java.time.chrono.ChronoLocalDateTime<D>

to-local-time clj

(to-local-time this)

Gets the local time part of this date-time.

This returns a local time with the same hour, minute, second and nanosecond as this date-time.

returns: the time part of this date-time, not null - default java.time.LocalTime

to-string clj

(to-string this)

Outputs this date-time as a String.

The output will include the full zoned date-time.

returns: a string representation of this date-time, not null - java.lang.String

with clj

(with this adjuster)

(with this field new-value)

Returns an object of the same type as this object with the specified field altered.

This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

field - the field to set in the result, not null - java.time.temporal.TemporalField new-value - the new value of the field in the result - long

returns: an object of the same type with the specified field set, not null - java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if the field cannot be set

with-earlier-offset-at-overlap clj

(with-earlier-offset-at-overlap this)

Returns a copy of this date-time changing the zone offset to the earlier of the two valid offsets at a local time-line overlap.

This method only has any effect when the local time-line overlaps, such as at an autumn daylight savings cutover. In this scenario, there are two valid offsets for the local date-time. Calling this method will return a zoned date-time with the earlier of the two selected.

If this method is called when it is not an overlap, this is returned.

This instance is immutable and unaffected by this method call.

returns: a ChronoZonedDateTime based on this date-time with the earlier offset, not null - java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if no rules are valid for this date-time

with-later-offset-at-overlap clj

(with-later-offset-at-overlap this)

Returns a copy of this date-time changing the zone offset to the later of the two valid offsets at a local time-line overlap.

This method only has any effect when the local time-line overlaps, such as at an autumn daylight savings cutover. In this scenario, there are two valid offsets for the local date-time. Calling this method will return a zoned date-time with the later of the two selected.

If this method is called when it is not an overlap, this is returned.

This instance is immutable and unaffected by this method call.

returns: a ChronoZonedDateTime based on this date-time with the later offset, not null - java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if no rules are valid for this date-time

with-zone-same-instant clj

(with-zone-same-instant this zone)

Returns a copy of this date-time with a different time-zone, retaining the instant.

This method changes the time-zone and retains the instant. This normally results in a change to the local date-time.

This method is based on retaining the same instant, thus gaps and overlaps in the local time-line have no effect on the result.

To change the offset while keeping the local time, use withZoneSameLocal(ZoneId).

zone - the time-zone to change to, not null - java.time.ZoneId

returns: a ChronoZonedDateTime based on this date-time with the requested zone, not null - java.time.chrono.ChronoZonedDateTime<D>

throws: java.time.DateTimeException - if the result exceeds the supported date range

with-zone-same-local clj

(with-zone-same-local this zone)

Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible.

This method changes the time-zone and retains the local date-time. The local date-time is only changed if it is invalid for the new zone.

To change the zone and adjust the local date-time, use withZoneSameInstant(ZoneId).

This instance is immutable and unaffected by this method call.

zone - the time-zone to change to, not null - java.time.ZoneId

returns: a ChronoZonedDateTime based on this date-time with the requested zone, not null - java.time.chrono.ChronoZonedDateTime<D>