X Tutup
Liking cljdoc? Tell your friends :D
Clojure only.

java-time

absclj

(abs a)

Returns the absolute value of a temporal amount:

(abs (negate x)) == (abs x)

Returns the absolute value of a temporal amount:

(abs (negate x)) == (abs x)
raw docstring

abuts?clj

(abuts? i oi)

True if this interval abut with the other one

True if this interval abut with the other one
raw docstring

adjustclj

(adjust entity adjuster & args)

Adjusts the temporal entity using the provided adjuster with optional args.

The adjuster should either be a keyword which resolves to one of the predefined adjusters (see java-time.repl/show-adjusters) an instance of TemporalAdjuster or a function which returns another temporal entity when applied to the given one:

(adjust (local-date 2015 1 1) :next-working-day) => #<LocalDate 2015-1-2>

(adjust (local-date 2015 1 1) :first-in-month :monday) => #<LocalDate 2015-1-5>

(adjust (local-date 2015 1 1) plus (days 1)) => #<LocalDate 2015-1-2>

Adjusts the temporal `entity` using the provided `adjuster` with optional `args`.

The adjuster should either be a keyword which resolves to one of the
predefined adjusters (see `java-time.repl/show-adjusters`) an instance of
`TemporalAdjuster` or a function which returns another temporal entity when
applied to the given one:

  (adjust (local-date 2015 1 1) :next-working-day)
  => #<LocalDate 2015-1-2>

  (adjust (local-date 2015 1 1) :first-in-month :monday)
  => #<LocalDate 2015-1-5>

  (adjust (local-date 2015 1 1) plus (days 1))
  => #<LocalDate 2015-1-2>
raw docstring

after?clj

(after? x)
(after? x y)
(after? x y & more)

Returns non-nil if time entities are ordered from the earliest to the latest (same semantics as >):

(after? (local-date 2011) (local-date 2010) (local-date 2009)) => truthy...

(after? (instant 99999999) (interval (instant 10000) (instant 1000000))) => truthy...

Returns non-nil if time entities are ordered from the earliest to the latest
(same semantics as `>`):

  (after? (local-date 2011) (local-date 2010) (local-date 2009))
  => truthy...

  (after? (instant 99999999)
          (interval (instant 10000) (instant 1000000)))
  => truthy...
raw docstring

am-pmclj

(am-pm)
(am-pm v__3807__auto__)
(am-pm fmt__3808__auto__ arg__3809__auto__)

Returns the AmPm for the given keyword name (:am or :pm), ordinal or entity. Current AM/PM if no arguments given.

Returns the `AmPm` for the given keyword name (`:am` or `:pm`),
ordinal or entity. Current AM/PM if no arguments given.
raw docstring

am-pm?clj

(am-pm? o__3806__auto__)

asclj

(as o k)
(as o k1 k2)
(as o k1 k2 & ks)

Values of property/unit identified by keys/objects ks of the temporal entity o, e.g.

(as (duration 1 :hour) :minutes) => 60

(as (local-date 2015 9) :year :month-of-year) => [2015 9]

Values of property/unit identified by keys/objects `ks` of the temporal
entity `o`, e.g.

  (as (duration 1 :hour) :minutes)
  => 60

  (as (local-date 2015 9) :year :month-of-year)
  => [2015 9]
raw docstring

as-mapclj

(as-map e)
(as-map e value-fn)

Converts a time entity to a map of property key -> value as defined by the passed in value-fn. By default the actual value of the unit/field is produced.

(as-map (duration)) => {:nanos 0, :seconds 0}

(as-map (local-date 2015 1 1)) => {:year 2015, :month-of-year 1, :day-of-month 1, ...}

Converts a time entity to a map of property key -> value as defined by the
passed in `value-fn`. By default the actual value of the unit/field is
produced.

  (as-map (duration))
  => {:nanos 0, :seconds 0}

  (as-map (local-date 2015 1 1))
  => {:year 2015, :month-of-year 1, :day-of-month 1, ...}
raw docstring

available-zone-idsclj

(available-zone-ids)

before?clj

(before? x)
(before? x y)
(before? x y & more)

Returns non-nil if time entities are ordered from the earliest to the latest (same semantics as <):

(before? (local-date 2009) (local-date 2010) (local-date 2011)) => truthy...

(before? (interval (instant 10000) (instant 1000000)) (instant 99999999)) => truthy...

Returns non-nil if time entities are ordered from the earliest to the latest
(same semantics as `<`):

  (before? (local-date 2009) (local-date 2010) (local-date 2011))
  => truthy...

  (before? (interval (instant 10000) (instant 1000000))
           (instant 99999999))
  => truthy...
raw docstring

chronologyclj

(chronology o)

The Chronology of the entity

The `Chronology` of the entity
raw docstring

contains?clj

(contains? i o)

True if the interval contains the given instant or interval

True if the interval contains the given instant or interval
raw docstring

convert-amountclj

(convert-amount amount from-unit to-unit)

Converts an amount from one unit to another. Returns a map of:

  • :whole - the whole part of the conversion in the to unit
  • :remainder - the remainder in the from unit

Arguments may be keywords or instances of TemporalUnit.

Converts between precise units - nanos up to weeks, treating days as exact multiples of 24 hours. Also converts between imprecise units - months up to millenia. See ChronoUnit and IsoFields for all of the supported units. Does not convert between precise and imprecise units.

Throws ArithmeticException if long overflow occurs during computation.

(convert-amount 10000 :seconds :hours) => {:remainder 2800 :whole 2}

Converts an amount from one unit to another. Returns a map of:
  * `:whole` - the whole part of the conversion in the `to` unit
  * `:remainder` - the remainder in the `from` unit

Arguments may be keywords or instances of `TemporalUnit`.

Converts between precise units - nanos up to weeks, treating days as exact
multiples of 24 hours. Also converts between imprecise units - months up to
millenia. See `ChronoUnit` and `IsoFields` for all of the supported units.
Does not convert between precise and imprecise units.

Throws `ArithmeticException` if long overflow occurs during computation.

  (convert-amount 10000 :seconds :hours)
  => {:remainder 2800 :whole 2}
raw docstring

day-of-monthclj

(day-of-month)
(day-of-month G__4010)
(day-of-month fmt__3840__auto__ arg__3841__auto__)

Returns the DayOfMonth for the given entity, clock, zone or day of month. Current day of month if no arguments given.

Returns the `DayOfMonth` for the given entity, clock, zone or day of month.
Current day of month if no arguments given.
raw docstring

day-of-month?clj

(day-of-month? o__3839__auto__)

day-of-weekclj

(day-of-week)
(day-of-week v__3807__auto__)
(day-of-week fmt__3808__auto__ arg__3809__auto__)

Returns the DayOfWeek for the given day keyword name (e.g. :monday), ordinal or entity. Current day if no arguments given.

Returns the `DayOfWeek` for the given day keyword name (e.g. `:monday`),
ordinal or entity. Current day if no arguments given.
raw docstring

day-of-week?clj

(day-of-week? o__3806__auto__)

day-of-yearclj

(day-of-year)
(day-of-year G__4021)
(day-of-year fmt__3840__auto__ arg__3841__auto__)

Returns the DayOfYear for the given entity, clock, zone or day of year. Current day of year if no arguments given.

Returns the `DayOfYear` for the given entity, clock, zone or day of year.
Current day of year if no arguments given.
raw docstring

day-of-year?clj

(day-of-year? o__3839__auto__)

daysclj

(days v__3267__auto__)

durationclj

(duration)
(duration arg_1_3220)
(duration arg_1_3221 arg_2_3222)

Creates a duration - a temporal entity representing standard days, hours, minutes, millis, micros and nanos. The duration itself contains only seconds and nanos as properties.

Given one argument will

  • interpret as millis if a number
  • try to parse from the standard format if a string
  • extract supported units from another TemporalAmount
  • convert from a Joda Period/Duration

Given two arguments will

  • get a duration between two Temporals
  • get a duration of a specified unit, e.g. (duration 100 :seconds)
Creates a duration - a temporal entity representing standard days, hours,
minutes, millis, micros and nanos. The duration itself contains only seconds
and nanos as properties.

Given one argument will
  * interpret as millis if a number
  * try to parse from the standard format if a string
  * extract supported units from another `TemporalAmount`
  * convert from a Joda Period/Duration

Given two arguments will
  * get a duration between two `Temporal`s
  * get a duration of a specified unit, e.g. `(duration 100 :seconds)`
raw docstring

duration?clj

(duration? v__2347__auto__)

True if an instance of Duration.

True if an instance of Duration.
raw docstring

endclj

(end i)

Gets the end instant of the interval

Gets the end instant of the interval
raw docstring

fieldclj

(field k)
(field entity k)

Returns a TemporalField for the given key k or extracts the field from the given temporal entity.

You can see predefined fields via java-time.repl/show-fields.

If you want to make your own custom TemporalFields resolvable, you need to rebind the java-time.properties/*fields* to a custom java-time.properties.FieldGroup.

Returns a `TemporalField` for the given key `k` or extracts the field from
the given temporal `entity`.

You can see predefined fields via `java-time.repl/show-fields`.

If you want to make your own custom TemporalFields resolvable, you need to rebind the
`java-time.properties/*fields*` to a custom `java-time.properties.FieldGroup`.
raw docstring

field?clj

(field? o)

True if this is a TemporalField.

True if this is a `TemporalField`.
raw docstring

fieldsclj

(fields o)

Fields present in this temporal entity

Fields present in this temporal entity
raw docstring

fixed-clockclj

(fixed-clock)
(fixed-clock i)
(fixed-clock i z)

Creates a fixed clock either at the current instant or at the supplied instant/instant + zone.

Creates a fixed clock either at the current instant or at the supplied
instant/instant + zone.
raw docstring

formatclj

(format o)
(format fmt o)

Formats the given time entity as a string.

Accepts something that can be converted to a DateTimeFormatter as a first argument. Given one argument uses the default format.

Formats the given time entity as a string.

Accepts something that can be converted to a `DateTimeFormatter` as a first
argument. Given one argument uses the default format.
raw docstring

formatterclj

(formatter fmt)
(formatter fmt {:keys [resolver-style]})

Constructs a DateTimeFormatter out of a

  • format string - "YYYY/mm/DD", "YYY HH:MM", etc.
  • formatter name - :date, :time-no-millis, etc.

Accepts a map of options as an optional second argument:

  • resolver-style - either :strict, :smartor :lenient
Constructs a DateTimeFormatter out of a

* format string - "YYYY/mm/DD", "YYY HH:MM", etc.
* formatter name - :date, :time-no-millis, etc.

Accepts a map of options as an optional second argument:

* `resolver-style` - either `:strict`, `:smart `or `:lenient`
raw docstring

friday?clj

(friday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a friday.

Returns true if the given time entity with the
`day-of-week` property falls on a friday.
raw docstring

gapclj

(gap i oi)

Gets the gap between this interval and the other one or nil

Gets the gap between this interval and the other one or `nil`
raw docstring

hoursclj

(hours v__3246__auto__)

Duration of a specified number of hours.

Duration of a specified number of hours.
raw docstring

instantclj

(instant)
(instant arg_1_2873)
(instant arg_1_2874 arg_2_2875)

Creates an Instant. The following arguments are supported:

  • no arguments - current instant
  • one argument
    • clock
    • java.util.Date/Calendar
    • another temporal entity
    • string representation
    • millis from epoch
  • two arguments
    • formatter (format) and a string
Creates an `Instant`. The following arguments are supported:

* no arguments - current instant
* one argument
  + clock
  + java.util.Date/Calendar
  + another temporal entity
  + string representation
  + millis from epoch
* two arguments
  + formatter (format) and a string
raw docstring

instant?clj

(instant? v__2347__auto__)

True if an instance of Instant.

True if an instance of Instant.
raw docstring

intervalclj

(interval o)
(interval a b)

Constructs an interval out of a string, start and end instants or a start

  • duration:

(j/interval "2010-01-01T00:00:00Z/2013-01-01T00:00:00Z") => #<Interval 2010-01-01T00:00:00Z/2013-01-01T00:00:00Z>

(j/interval (j/instant 100000) (j/instant 1000000)) => #<Interval 1970-01-01T00:01:40Z/1970-01-01T00:16:40Z>

(j/interval (j/instant 100000) (j/duration 15 :minutes)) => #<Interval 1970-01-01T00:01:40Z/1970-01-01T00:16:40Z>

Constructs an interval out of a string, start and end instants or a start
+ duration:

(j/interval "2010-01-01T00:00:00Z/2013-01-01T00:00:00Z")
=> #<Interval 2010-01-01T00:00:00Z/2013-01-01T00:00:00Z>

(j/interval (j/instant 100000) (j/instant 1000000))
=> #<Interval 1970-01-01T00:01:40Z/1970-01-01T00:16:40Z>

(j/interval (j/instant 100000) (j/duration 15 :minutes))
=> #<Interval 1970-01-01T00:01:40Z/1970-01-01T00:16:40Z>
raw docstring

interval?clj

(interval? o)

True if Interval

True if `Interval`
raw docstring

iterateclj

(iterate f initial v & vs)

Returns a lazy sequence of initial , (apply f initial v vs), etc.

Useful when you want to produce a sequence of temporal entities, for example:

(iterate plus (days 0) 1) => (#<Period P0D> #<Period P1D> #<Period P2D> ...)

(iterate plus (local-date 2010 1 1) (years 1)) => (#<LocalDate 2010-01-01> #<LocalDate 2011-01-01> ...)

(iterate adjust (local-date 2010 1 1) :next-working-day) => (#<LocalDate 2010-01-01> #<LocalDate 2010-01-04> ...)

Returns a lazy sequence of `initial` , `(apply f initial v vs)`, etc.

Useful when you want to produce a sequence of temporal entities, for
example:

  (iterate plus (days 0) 1)
  => (#<Period P0D> #<Period P1D> #<Period P2D> ...)

  (iterate plus (local-date 2010 1 1) (years 1))
  => (#<LocalDate 2010-01-01> #<LocalDate 2011-01-01> ...)

  (iterate adjust (local-date 2010 1 1) :next-working-day)
  => (#<LocalDate 2010-01-01> #<LocalDate 2010-01-04> ...)
raw docstring

largest-min-valueclj

(largest-min-value p)

Largest minimum value of this property

Largest minimum value of this property
raw docstring

leap?clj

(leap? o)

True if the year of this entity is a leap year.

True if the year of this entity is a leap year.
raw docstring

local-dateclj

(local-date)
(local-date arg_1_2924)
(local-date arg_1_2925 arg_2_2926)
(local-date arg_1_2927 arg_2_2928 arg_3_2929)

Creates a LocalDate. The following arguments are supported:

  • no arguments - current local-date
  • one argument
    • clock
    • another temporal entity
    • string representation
    • year
  • two arguments
    • formatter (format) and a string
    • an instant and a zone id
    • another temporal entity and an offset (preserves local time)
    • year and month
  • three arguments
    • year, month and date
Creates a `LocalDate`. The following arguments are supported:

* no arguments - current local-date
* one argument
  + clock
  + another temporal entity
  + string representation
  + year
* two arguments
  + formatter (format) and a string
  + an instant and a zone id
  + another temporal entity and an offset (preserves local time)
  + year and month
* three arguments
  + year, month and date
raw docstring

local-date-timeclj

(local-date-time)
(local-date-time arg_1_3004)
(local-date-time arg_1_3005 arg_2_3006)
(local-date-time arg_1_3007 arg_2_3008 arg_3_3009)
(local-date-time y m d h)
(local-date-time y m d h mm)
(local-date-time y m d h mm ss)
(local-date-time y m d h mm ss n)

Creates a LocalDateTime. The following arguments are supported:

  • no arguments - current local date-time
  • one argument
    • clock
    • another temporal entity
    • string representation
    • year
  • two arguments
    • local date and local time
    • an instant and a zone id
    • formatter (format) and a string
    • year and month

three and more arguments - year/month/day/...

Creates a `LocalDateTime`. The following arguments are supported:

* no arguments - current local date-time
* one argument
  + clock
  + another temporal entity
  + string representation
  + year
* two arguments
  + local date and local time
  + an instant and a zone id
  + formatter (format) and a string
  + year and month

three and more arguments - year/month/day/...
raw docstring

local-date-time?clj

(local-date-time? v__2347__auto__)

True if an instance of LocalDateTime.

True if an instance of LocalDateTime.
raw docstring

local-date?clj

(local-date? v__2347__auto__)

True if an instance of LocalDate.

True if an instance of LocalDate.
raw docstring

local-timeclj

(local-time)
(local-time arg_1_2964)
(local-time arg_1_2965 arg_2_2966)
(local-time arg_1_2967 arg_2_2968 arg_3_2969)
(local-time h m s nn)

Creates a LocalTime. The following arguments are supported:

  • no arguments - current local time
  • one argument
    • clock
    • another temporal entity
    • string representation
    • hours
  • two arguments
    • formatter (format) and a string
    • an instant and a zone id
    • hours and minutes
  • three/four arguments - hour, minute, second, nanos
Creates a `LocalTime`. The following arguments are supported:

* no arguments - current local time
* one argument
  + clock
  + another temporal entity
  + string representation
  + hours
* two arguments
  + formatter (format) and a string
  + an instant and a zone id
  + hours and minutes
* three/four arguments - hour, minute, second, nanos
raw docstring

local-time?clj

(local-time? v__2347__auto__)

True if an instance of LocalTime.

True if an instance of LocalTime.
raw docstring

maxclj

(max o & os)

Latest/longest of the given time entities. Entities should be of the same type

Latest/longest of the given time entities. Entities should be of the same
type
raw docstring

max-valueclj

(max-value p)

Maximum value of this property, e.g. 29th of February for months

Maximum value of this property, e.g. 29th of February for months
raw docstring

microsclj

(micros micros)

Duration of a specified number of microseconds.

Duration of a specified number of microseconds.
raw docstring

millisclj

(millis v__3246__auto__)

Duration of a specified number of millis.

Duration of a specified number of millis.
raw docstring

minclj

(min o & os)

Earliest/shortest of the given time entities. Entities should be of the same type

Earliest/shortest of the given time entities. Entities should be of the same
type
raw docstring

min-valueclj

(min-value p)

Minimum value of this property

Minimum value of this property
raw docstring

minusclj

(minus o & os)

Subtracts all of the os from the time entity o

(j/minus (j/local-date 2015) (j/years 1)) => <java.time.LocalDate "2014-01-01">

Subtracts all of the `os` from the time entity `o`

(j/minus (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2014-01-01">
raw docstring

minutesclj

(minutes v__3246__auto__)

Duration of a specified number of minutes.

Duration of a specified number of minutes.
raw docstring

monday?clj

(monday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a monday.

Returns true if the given time entity with the
`day-of-week` property falls on a monday.
raw docstring

monthclj

(month)
(month v__3807__auto__)
(month fmt__3808__auto__ arg__3809__auto__)

Returns the Month for the given month keyword name (e.g. :january), ordinal or entity. Current month if no arguments given.

Returns the `Month` for the given month keyword name (e.g. `:january`),
ordinal or entity. Current month if no arguments given.
raw docstring

month-dayclj

(month-day)
(month-day G__3932)
(month-day a__3853__auto__ b__3854__auto__)

Returns the MonthDay for the given entity, string, clock, zone or month/day combination. Current month-day if no arguments given.

Returns the `MonthDay` for the given entity, string, clock, zone or
month/day combination. Current month-day if no arguments given.
raw docstring

month-day?clj

(month-day? o__3850__auto__)

month?clj

(month? o__3806__auto__)

monthsclj

(months v__3267__auto__)

move-end-byclj

(move-end-by i & os)

Moves the end instant of the interval by the sum of given periods/durations/numbers of milliseconds.

(move-start-by (interval 0 10000) (millis 1000) (seconds 1)) => #<Interval ...:00Z/...:12Z>

Fails if the new end instant falls before the start instant.

(move-end-by (interval 0 10000) (millis -11000)) => DateTimeException...

Moves the end instant of the interval by the sum of given
periods/durations/numbers of milliseconds.

  (move-start-by (interval 0 10000) (millis 1000) (seconds 1))
  => #<Interval ...:00Z/...:12Z>

Fails if the new end instant falls before the start instant.

  (move-end-by (interval 0 10000) (millis -11000))
  => DateTimeException...
raw docstring

move-end-toclj

(move-end-to i new-end)

Moves the end of the interval to the given instant (or something convertible to an instant):

(move-end-to (interval 0 10000) (instant 15000)) => #<Interval ...:00Z/...:15Z>

Fails if the new end instant falls before the start instant:

(move-end-to (interval 0 10000) (millis -1)) => DateTimeException...

Moves the end of the interval to the given instant (or something
 convertible to an instant):

 (move-end-to (interval 0 10000) (instant 15000))
 => #<Interval ...:00Z/...:15Z>

Fails if the new end instant falls before the start instant:

 (move-end-to (interval 0 10000) (millis -1))
 => DateTimeException...
raw docstring

move-start-byclj

(move-start-by i & os)

Moves the start instant of the interval by the sum of given periods/durations/numbers of milliseconds:

(move-start-by (interval 0 10000) (millis 1000) (seconds 1)) => #<Interval ...:02Z/...:10Z>

Fails if the new start instant falls after the end instant.

(move-start-by (interval 0 10000) (millis 11000)) ; => DateTimeException...

Moves the start instant of the interval by the sum of given
periods/durations/numbers of milliseconds:

  (move-start-by (interval 0 10000) (millis 1000) (seconds 1))
  => #<Interval ...:02Z/...:10Z>

Fails if the new start instant falls after the end instant.

  (move-start-by (interval 0 10000) (millis 11000))
  ; => DateTimeException...
raw docstring

move-start-toclj

(move-start-to i new-start)

Moves the start instant of the interval to the given instant (or something convertible to an instant):

(move-start-to (interval 0 10000) (instant 5000)) => #<Interval ...:05Z/...:10Z>

Fails if the new start instant falls after the end instant:

(move-start-to (interval 0 10000) (millis 15000)) => DateTimeException...

Moves the start instant of the interval to the given instant (or something
 convertible to an instant):

 (move-start-to (interval 0 10000) (instant 5000))
 => #<Interval ...:05Z/...:10Z>

Fails if the new start instant falls after the end instant:

 (move-start-to (interval 0 10000) (millis 15000))
 => DateTimeException...
raw docstring

multiply-byclj

(multiply-by o v)

Entity o mutlitplied by the value v

Entity `o` mutlitplied by the value `v`
raw docstring

nanosclj

(nanos v__3246__auto__)

Duration of a specified number of nanos.

Duration of a specified number of nanos.
raw docstring

negateclj

(negate a)

Negates a temporal amount:

(negate (negate x)) == x

Negates a temporal amount:

(negate (negate x)) == x
raw docstring

negative?clj

(negative? a)

True if the amount is negative

True if the amount is negative
raw docstring

offset-clockclj

(offset-clock d)
(offset-clock c d)

Creates a clock offset from the current/provided clock by a given duration.

Creates a clock offset from the current/provided clock by a given
`duration`.
raw docstring

offset-date-timeclj

(offset-date-time)
(offset-date-time arg_1_3445)
(offset-date-time arg_1_3446 arg_2_3447)
(offset-date-time arg_1_3448 arg_2_3449 arg_3_3450)
(offset-date-time y m d h)
(offset-date-time y mo d h m)
(offset-date-time y mo d h m s)
(offset-date-time y mo d h m s n)
(offset-date-time y mo d h m s n o)

Creates an OffsetDateTime. The following arguments are supported:

  • no arguments - current date-time with the default offset
  • one argument
    • clock
    • another temporal entity
    • string representation
    • year
  • two arguments
    • formatter (format) and a string
    • local date-time and an offset
    • another temporal entity and an offset (preserves local time)
    • year and month
  • three arguments
    • local date, local time and an offset
    • year, month and date
  • four up to seven arguments - position date-time constructors
  • eight arguments - time fields up to nanoseconds and a zone offset

If zone offset is not specified, default will be used. You can check the default offset by invoking (zone-offset).

Creates an `OffsetDateTime`. The following arguments are supported:

  * no arguments - current date-time with the default offset
  * one argument
    + clock
    + another temporal entity
    + string representation
    + year
  * two arguments
    + formatter (format) and a string
    + local date-time and an offset
    + another temporal entity and an offset (preserves local time)
    + year and month
  * three arguments
    + local date, local time and an offset
    + year, month and date
  * four up to seven arguments - position date-time constructors
  * eight arguments - time fields up to nanoseconds and a zone offset

If zone offset is not specified, default will be used. You can check the
default offset by invoking `(zone-offset)`.
raw docstring

offset-date-time?clj

(offset-date-time? v__2347__auto__)

True if an instance of OffsetDateTime.

True if an instance of OffsetDateTime.
raw docstring

offset-timeclj

(offset-time)
(offset-time arg_1_3485)
(offset-time arg_1_3486 arg_2_3487)
(offset-time h m s)
(offset-time h m s n)
(offset-time h m s n o)

Creates an OffsetTime. The following arguments are supported:

  • no arguments - current time with the default offset
  • one argument
    • clock
    • zone id
    • another temporal entity
    • string representation
    • hour
  • two arguments
    • formatter (format) and a string
    • local time and an offset
    • instant and an offset
    • hour and minutes
  • three arguments - hours, minutes, seconds
  • four arguments - hours, minutes, seconds, nanos
  • five arguments - last is the offset

If zone offset is not specified, default will be used. You can check the default offset by invoking (zone-offset).

Creates an `OffsetTime`. The following arguments are supported:

  * no arguments - current time with the default offset
  * one argument
    + clock
    + zone id
    + another temporal entity
    + string representation
    + hour
  * two arguments
    + formatter (format) and a string
    + local time and an offset
    + instant and an offset
    + hour and minutes
  * three arguments - hours, minutes, seconds
  * four arguments - hours, minutes, seconds, nanos
  * five arguments - last is the offset

If zone offset is not specified, default will be used. You can check the
default offset by invoking `(zone-offset)`.
raw docstring

offset-time?clj

(offset-time? v__2347__auto__)

True if an instance of OffsetTime.

True if an instance of OffsetTime.
raw docstring

overlapclj

(overlap i oi)

Gets the overlap between this interval and the other one or nil

Gets the overlap between this interval and the other one or `nil`
raw docstring

overlaps?clj

(overlaps? i oi)

True if this interval overlaps the other one

True if this interval overlaps the other one
raw docstring

periodclj

(period)
(period arg_1_3280)
(period arg_1_3281 arg_2_3282)
(period arg_1_3283 arg_2_3284 arg_3_3285)

Creates a period - a temporal entity consisting of years, months and days.

Given one argument will

  • interpret as years if a number
  • try to parse from the standard format if a string
  • extract supported units from another TemporalAmount
  • convert from a Joda Period

Given two arguments will

  • get a period of a specified unit, e.g. (period 10 :months)
  • get a period between two temporals by converting them to local dates
  • get a period of a specified number of years and months

Given three arguments will create a year/month/day period.

Creates a period - a temporal entity consisting of years, months and days.

Given one argument will
  * interpret as years if a number
  * try to parse from the standard format if a string
  * extract supported units from another `TemporalAmount`
  * convert from a Joda Period

Given two arguments will
  * get a period of a specified unit, e.g. `(period 10 :months)`
  * get a period between two temporals by converting them to local dates
  * get a period of a specified number of years and months

Given three arguments will create a year/month/day period.
raw docstring

period?clj

(period? v__2347__auto__)

True if an instance of Period.

True if an instance of Period.
raw docstring

plusclj

(plus o & os)

Adds all of the os to the time entity o

(j/plus (j/local-date 2015) (j/years 1)) => <java.time.LocalDate "2016-01-01">

Adds all of the `os` to the time entity `o`

(j/plus (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2016-01-01">
raw docstring

propertiesclj

(properties o)

Map of properties present in this temporal entity

Map of properties present in this temporal entity
raw docstring

propertyclj

(property o k)

Property of this temporal entity under key k

Property of this temporal entity under key `k`
raw docstring

quarterclj

(quarter)
(quarter v__3807__auto__)
(quarter fmt__3808__auto__ arg__3809__auto__)

Returns the Quarter for the given quarter keyword name (e.g. :q1), ordinal or entity. Current quarter if no arguments given.

Returns the `Quarter` for the given quarter keyword name (e.g. `:q1`),
ordinal or entity. Current quarter if no arguments given.
raw docstring

quarter?clj

(quarter? o__3806__auto__)

rangeclj

(range p)

Range of values for this property

Range of values for this property
raw docstring

saturday?clj

(saturday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a saturday.

Returns true if the given time entity with the
`day-of-week` property falls on a saturday.
raw docstring

secondsclj

(seconds v__3246__auto__)

Duration of a specified number of seconds.

Duration of a specified number of seconds.
raw docstring

smallest-max-valueclj

(smallest-max-value p)

Smallest maximum value of this property, e.g. 28th of February for months

Smallest maximum value of this property, e.g. 28th of February for months
raw docstring

standard-daysclj

(standard-days v__3246__auto__)

Duration of a specified number of days.

Duration of a specified number of days.
raw docstring

startclj

(start i)

Gets the start instant of the interval

Gets the start instant of the interval
raw docstring

sunday?clj

(sunday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a sunday.

Returns true if the given time entity with the
`day-of-week` property falls on a sunday.
raw docstring

supports?clj

(supports? o p)

True if the o entity supports the p property

True if the `o` entity supports the `p` property
raw docstring

system-clockclj

(system-clock)
(system-clock k)

Creates a system clock. In the default timezone if called without arguments, otherwise accepts a Zone Id.

Creates a system clock. In the default timezone if called without arguments,
otherwise accepts a Zone Id.
raw docstring

thursday?clj

(thursday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a thursday.

Returns true if the given time entity with the
`day-of-week` property falls on a thursday.
raw docstring

tick-clockclj

(tick-clock d)
(tick-clock c d)

Creates a clock wrapping system/provided clock that only ticks as per specified duration.

Creates a clock wrapping system/provided clock that only ticks as per
specified duration.
raw docstring

time-betweenclj

(time-between o e u)

Time between temporal entities o and e in unit u.

(j/time-between (j/local-date 2015) (j/local-date 2016) :days) => 365

(j/time-between :days (j/local-date 2015) (j/local-date 2016)) => 365

Time between temporal entities `o` and `e` in unit `u`.

(j/time-between (j/local-date 2015) (j/local-date 2016) :days)
=> 365

(j/time-between :days (j/local-date 2015) (j/local-date 2016))
=> 365
raw docstring

to-java-dateclj

(to-java-date o)

Converts a date entity to a java.util.Date.

Converts a date entity to a `java.util.Date`.
raw docstring

to-millis-from-epochclj

(to-millis-from-epoch o)

Converts a date entity to a long representing the number of milliseconds from epoch.

Converts a date entity to a `long` representing the number of milliseconds
from epoch.
raw docstring

to-sql-dateclj

(to-sql-date o)

Converts a date entity to a java.sql.Date.

Converts a date entity to a `java.sql.Date`.
raw docstring

to-sql-timestampclj

(to-sql-timestamp o)

Converts a date entity to a java.sql.Timestamp.

Converts a date entity to a `java.sql.Timestamp`.
raw docstring

truncate-toclj

(truncate-to o u)

Truncates this entity to the specified time unit. Only works for units that divide into the length of standard day without remainder (up to :days).

Truncates this entity to the specified time unit. Only works for units that
divide into the length of standard day without remainder (up to `:days`).
raw docstring

tuesday?clj

(tuesday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a tuesday.

Returns true if the given time entity with the
`day-of-week` property falls on a tuesday.
raw docstring

unitclj

(unit k)
(unit entity k)

Returns a TemporalUnit for the given key k or extracts the field from the given temporal entity.

You can see predefined units via java-time.repl/show-units.

If you want to make your own custom TemporalUnits resolvable, you need to rebind the java-time.properties/*units* to a custom java-time.properties.UnitGroup.

Returns a `TemporalUnit` for the given key `k` or extracts the field from
the given temporal `entity`.

You can see predefined units via `java-time.repl/show-units`.

If you want to make your own custom TemporalUnits resolvable, you need to rebind the
`java-time.properties/*units*` to a custom `java-time.properties.UnitGroup`.
raw docstring

unit?clj

(unit? o)

True if this is a TemporalUnit.

True if this is a `TemporalUnit`.
raw docstring

unitsclj

(units o)

Units present in this temporal entity.

Units present in this temporal entity.
raw docstring

valueclj

(value p)

Value of the property

Value of the property
raw docstring

value-rangeclj

(value-range {:keys [min-smallest min-largest max-smallest max-largest]})
(value-range min max)

Creates a ValueRange given the min and max amounts or a map of :min-smallest, :max-smallest, :min-largest and :max-largest.

Creates a `ValueRange` given the `min` and `max` amounts or a map of
`:min-smallest`, `:max-smallest`, `:min-largest` and `:max-largest`.
raw docstring

wednesday?clj

(wednesday? o__4118__auto__)

Returns true if the given time entity with the day-of-week property falls on a wednesday.

Returns true if the given time entity with the
`day-of-week` property falls on a wednesday.
raw docstring

weekday?clj

(weekday? dt)

weekend?clj

(weekend? dt)

weeksclj

(weeks v__3267__auto__)

with-clockcljmacro

(with-clock c & forms)

Executes the given forms in the scope of the provided clock.

All the temporal entities that get created without parameters will inherit their values from the clock:

(with-clock (system-clock "Europe/London") (zone-id)) => #<java.time.ZoneRegion Europe/London>

Executes the given `forms` in the scope of the provided `clock`.

All the temporal entities that get created without parameters will inherit
their values from the clock:

  (with-clock (system-clock "Europe/London")
    (zone-id))
  => #<java.time.ZoneRegion Europe/London>
raw docstring

with-clock-fnclj

(with-clock-fn c f)

Executes the given function in the scope of the provided clock. All the temporal entities that get created without parameters will inherit their values from the clock.

Executes the given function in the scope of the provided clock. All the
temporal entities that get created without parameters will inherit their
values from the clock.
raw docstring

with-largest-min-valueclj

(with-largest-min-value p)

Underlying temporal entity with the value set to the largest minimum available for this property

Underlying temporal entity with the value set to the largest minimum
available for this property
raw docstring

with-max-valueclj

(with-max-value p)

Underlying temporal entity with the value set to the maximum available for this property

Underlying temporal entity with the value set to the maximum
available for this property
raw docstring

with-min-valueclj

(with-min-value p)

Underlying temporal entity with the value set to the minimum available for this property

Underlying temporal entity with the value set to the minimum available for
this property
raw docstring

with-offsetclj

(with-offset o offset)

Sets the offset to the specified value ensuring that the local time stays the same.

(offset-time 10 30 0 0 +2) => #<java.time.OffsetTime 10:30+02:00> (with-offset *1 +3) => #<java.time.OffsetTime 10:30+03:00>

Sets the offset to the specified value ensuring that the local time stays
the same.

  (offset-time 10 30 0 0 +2)
  => #<java.time.OffsetTime 10:30+02:00>
  (with-offset *1 +3)
  => #<java.time.OffsetTime 10:30+03:00>
raw docstring

with-offset-same-instantclj

(with-offset-same-instant o offset)

Sets the offset to the specified value ensuring that the result has the same instant, e.g.:

(offset-time 10 30 0 0 +2) => #<java.time.OffsetTime 10:30+02:00> (with-offset-same-instant *1 +3) => #<java.time.OffsetTime 11:30+03:00>

Sets the offset to the specified value ensuring that the result has the same instant, e.g.:

(offset-time 10 30 0 0 +2)
=> #<java.time.OffsetTime 10:30+02:00>
(with-offset-same-instant *1 +3)
=> #<java.time.OffsetTime 11:30+03:00>
raw docstring

with-smallest-max-valueclj

(with-smallest-max-value p)

Underlying temporal entity with the value set to the smallest maximum available for this property

Underlying temporal entity with the value set to the smallest maximum
available for this property
raw docstring

with-valueclj

(with-value p v)

Underlying temporal entity with the value of this property set to v

Underlying temporal entity with the value of this property set to `v`
raw docstring

with-zoneclj

(with-zone o z)

Returns this temporal entity with the specified ZoneId

Returns this temporal entity with the specified `ZoneId`
raw docstring

with-zone-same-instantclj

(with-zone-same-instant zdt z)

Sets the zone to the specified value ensuring that the result has the same instant, e.g.:

(zoned-date-time 2015) => #<java.time.ZonedDateTime 2015-01-01T00:00+00:00[Europe/London]> (with-zone-same-instant *1 "America/New_York") => #<java.time.ZonedDateTime 2014-12-31T18:00-05:00[America/New_York]>

Sets the zone to the specified value ensuring that the result has the same instant, e.g.:

(zoned-date-time 2015)
=> #<java.time.ZonedDateTime 2015-01-01T00:00+00:00[Europe/London]>
(with-zone-same-instant *1 "America/New_York")
=> #<java.time.ZonedDateTime 2014-12-31T18:00-05:00[America/New_York]>
raw docstring

yearclj

(year)
(year G__3921)
(year fmt__3840__auto__ arg__3841__auto__)

Returns the Year for the given entity, string, clock, zone or number. Current year if no arguments given.

Returns the `Year` for the given entity, string, clock, zone or number.
Current year if no arguments given.
raw docstring

year-monthclj

(year-month)
(year-month G__3947)
(year-month a__3853__auto__ b__3854__auto__)

Returns the YearMonth for the given entity, string, clock, zone or month/day combination. Current year-month if no arguments given.

Returns the `YearMonth` for the given entity, string, clock, zone or
month/day combination. Current year-month if no arguments given.
raw docstring

year-month?clj

(year-month? o__3850__auto__)

year-quarterclj

(year-quarter)
(year-quarter G__4033)
(year-quarter a__3853__auto__ b__3854__auto__)

Returns the YearQuarter for the given entity, clock, zone or year with quarter. Current year quarter if no arguments given.

Returns the `YearQuarter` for the given entity, clock, zone or year with quarter.
Current year quarter if no arguments given.
raw docstring

year-quarter?clj

(year-quarter? o__3850__auto__)

year?clj

(year? o__3839__auto__)

yearsclj

(years v__3267__auto__)

zero?clj

(zero? a)

True if the amount is zero

True if the amount is zero
raw docstring

zone-idclj

(zone-id)
(zone-id arg_1_3417)
(zone-id arg_1_3418 arg_2_3419)

Creates a ZoneId from a string identifier, java.util.TimeZone or extracts from another temporal entity.

Returns default system zone id if no arguments provided.

Given two arguments will use the second as the offset.

Creates a `ZoneId` from a string identifier, `java.util.TimeZone` or extracts
from another temporal entity.

Returns default system zone id if no arguments provided.

Given two arguments will use the second as the offset.
raw docstring

zone-offsetclj

(zone-offset)
(zone-offset o)
(zone-offset h m)
(zone-offset h m s)

Creates a ZoneOffset from a string identifier (e.g. "+01"), a number of hours/hours and minutes/hours, minutes and seconds or extracts from another temporal entity.

Returns default system zone offset if no arguments provided.

Creates a `ZoneOffset` from a string identifier (e.g. "+01"), a number of
hours/hours and minutes/hours, minutes and seconds or extracts from another
temporal entity.

Returns default system zone offset if no arguments provided.
raw docstring

zoned-date-timeclj

(zoned-date-time)
(zoned-date-time arg_1_3512)
(zoned-date-time arg_1_3513 arg_2_3514)
(zoned-date-time arg_1_3515 arg_2_3516 arg_3_3517)
(zoned-date-time y m d h)
(zoned-date-time y mo d h m)
(zoned-date-time y mo d h m s)
(zoned-date-time y mo d h m s n)
(zoned-date-time y mo d h m s n o)

Creates a ZonedDateTime. The following arguments are supported:

  • no arguments - current date-time in the default zone
  • one argument
    • clock
    • zone id
    • another temporal entity
    • string representation
    • year
  • two arguments
    • formatter and a string
    • local date-time and a zone id
    • year and month
  • three arguments
    • local date, local time and a zone id
    • year, month and day
  • four to seven arguments - date-time fields
  • eight arguments - last is the zone id

If zone id is not specified, default zone id will be used. You can check the default zone by invoking (zone-id).

Creates a `ZonedDateTime`. The following arguments are supported:

  * no arguments - current date-time in the default zone
  * one argument
    + clock
    + zone id
    + another temporal entity
    + string representation
    + year
  * two arguments
    + formatter and a string
    + local date-time and a zone id
    + year and month
  * three arguments
    + local date, local time and a zone id
    + year, month and day
  * four to seven arguments - date-time fields
  * eight arguments - last is the zone id

If zone id is not specified, default zone id will be used. You can check the
default zone by invoking `(zone-id)`.
raw docstring

zoned-date-time?clj

(zoned-date-time? v__2347__auto__)

True if an instance of ZonedDateTime.

True if an instance of ZonedDateTime.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close
X Tutup