Liking cljdoc? Tell your friends :D

java-time


abs

(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)
sourceraw docstring

abuts?

(abuts? i oi)

True if this interval abut with the other one

True if this interval abut with the other one
sourceraw docstring

adjust

(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) => nil

(adjust (local-date 2015 1 1) :first-in-month :monday) => nil

(adjust (local-date 2015 1 1) plus (days 1)) => nil

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)
  => nil

  (adjust (local-date 2015 1 1) :first-in-month :monday)
  => nil

  (adjust (local-date 2015 1 1) plus (days 1))
  => nil
sourceraw docstring

advance-clock!

(advance-clock! clock amount)

Advances the clock by the given time amount.

This mutates the mock clock.

Advances the `clock` by the given time `amount`.

This mutates the mock clock.
sourceraw docstring

after?

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

Returns non-nil if time entities are ordered from the latest to the earliest (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 latest to the earliest
(same semantics as `>`):

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

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

am-pm

(am-pm)
(am-pm v__3806__auto__)
(am-pm fmt__3807__auto__ arg__3808__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.
sourceraw docstring

am-pm?

(am-pm? o__3805__auto__)
source

as

(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]
sourceraw docstring

as-map

(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, ...}
sourceraw docstring

available-zone-ids

(available-zone-ids)
source

before?

(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...
sourceraw docstring

chronology

(chronology o)

The Chronology of the entity

The `Chronology` of the entity
sourceraw docstring

clock?

(clock? x)

Returns true if x is an instance of java.time.Clock.

Returns true if `x` is an instance of `java.time.Clock`.
sourceraw docstring

contains?

(contains? i o)

True if the interval contains the given instant or interval

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

convert-amount

(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}
sourceraw docstring

day-of-month

(day-of-month)
(day-of-month G__4014)
(day-of-month fmt__3839__auto__ arg__3840__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.
sourceraw docstring

day-of-month?

(day-of-month? o__3838__auto__)
source

day-of-week

(day-of-week)
(day-of-week v__3806__auto__)
(day-of-week fmt__3807__auto__ arg__3808__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.
sourceraw docstring

day-of-week?

(day-of-week? o__3805__auto__)
source

day-of-year

(day-of-year)
(day-of-year G__4025)
(day-of-year fmt__3839__auto__ arg__3840__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.
sourceraw docstring

day-of-year?

(day-of-year? o__3838__auto__)
source

days

(days v__3265__auto__)
source

duration

(duration)
(duration arg_1_3218)
(duration arg_1_3219 arg_2_3220)

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)`
sourceraw docstring

duration?

(duration? v__2344__auto__)

True if an instance of Duration.

True if an instance of Duration.
sourceraw docstring

end

(end i)

Gets the end instant of the interval

Gets the end instant of the interval
sourceraw docstring

field

(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`.
sourceraw docstring

field?

(field? o)

True if this is a TemporalField.

True if this is a `TemporalField`.
sourceraw docstring

fields

(fields o)

Fields present in this temporal entity

Fields present in this temporal entity
sourceraw docstring

fixed-clock

(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.
sourceraw docstring

format

(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.
sourceraw docstring

formatter

(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`
sourceraw docstring

friday?

(friday? o__4124__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.
sourceraw docstring

gap

(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`
sourceraw docstring

hours

(hours v__3244__auto__)

Duration of a specified number of hours.

Duration of a specified number of hours.
sourceraw docstring

instant

(instant)
(instant arg_1_2870)
(instant arg_1_2871 arg_2_2872)

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
sourceraw docstring

instant->sql-timestamp

(instant->sql-timestamp instant-or-millis)

Creates a java.sql.Timestamp from the provided instant-or-millis - a millisecond numeric time value or something convertible to an Instant.

Please consider using the JSR-310 Java Time types instead of java.sql.Timestamp if your drivers support them.

java.sql.Timestamp is a version of a java.util.Date supposed to be used as a local date-time (no timezone) for the purposes of conversion from/to native JDBC driver TIMESTAMP types.

Creates a `java.sql.Timestamp` from the provided `instant-or-millis` - a
millisecond numeric time value or something convertible to an `Instant`.

Please consider using the JSR-310 Java Time types instead of
`java.sql.Timestamp` if your drivers support them.

`java.sql.Timestamp` is a version of a `java.util.Date` supposed to be used
as a local date-time (no timezone) for the purposes of conversion from/to native
JDBC driver TIMESTAMP types.
sourceraw docstring

instant?

(instant? v__2344__auto__)

True if an instance of Instant.

True if an instance of Instant.
sourceraw docstring

interval

(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") => nil

(j/interval (j/instant 100000) (j/instant 1000000)) => nil

(j/interval (j/instant 100000) (j/duration 15 :minutes)) => nil

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")
=> nil

(j/interval (j/instant 100000) (j/instant 1000000))
=> nil

(j/interval (j/instant 100000) (j/duration 15 :minutes))
=> nil
sourceraw docstring

interval?

(interval? o)

True if Interval

True if `Interval`
sourceraw docstring

iterate

(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) => (nil nil nil ...)

(iterate plus (local-date 2010 1 1) (years 1)) => (nil nil ...)

(iterate adjust (local-date 2010 1 1) :next-working-day) => (nil nil ...)

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)
  => (nil nil nil ...)

  (iterate plus (local-date 2010 1 1) (years 1))
  => (nil nil ...)

  (iterate adjust (local-date 2010 1 1) :next-working-day)
  => (nil nil ...)
sourceraw docstring

java-date

(java-date)
(java-date a)
(java-date a b)

Creates a java.util.Date out of any combination of arguments valid for java-time/instant or the Instant itself.

A java.util.Date represents an instant in time. It's a direct analog of the java.time.Instant type introduced in the JSR-310. Please consider using the java.time.Instant (through java-time/instant) directly.

Creates a `java.util.Date` out of any combination of arguments valid for
`java-time/instant` or the Instant itself.

A `java.util.Date` represents an instant in time. It's a direct analog of the
`java.time.Instant` type introduced in the JSR-310. Please consider using the
`java.time.Instant` (through `java-time/instant`) directly.
sourceraw docstring

largest-min-value

(largest-min-value p)

Largest minimum value of this property

Largest minimum value of this property
sourceraw docstring

leap?

(leap? o)

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

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

local-date

(local-date)
(local-date arg_1_2921)
(local-date arg_1_2922 arg_2_2923)
(local-date arg_1_2924 arg_2_2925 arg_3_2926)

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
sourceraw docstring

local-date-time

(local-date-time)
(local-date-time arg_1_3001)
(local-date-time arg_1_3002 arg_2_3003)
(local-date-time arg_1_3004 arg_2_3005 arg_3_3006)
(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/...
sourceraw docstring

local-date-time?

(local-date-time? v__2344__auto__)

True if an instance of LocalDateTime.

True if an instance of LocalDateTime.
sourceraw docstring

local-date?

(local-date? v__2344__auto__)

True if an instance of LocalDate.

True if an instance of LocalDate.
sourceraw docstring

local-time

(local-time)
(local-time arg_1_2961)
(local-time arg_1_2962 arg_2_2963)
(local-time arg_1_2964 arg_2_2965 arg_3_2966)
(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
sourceraw docstring

local-time?

(local-time? v__2344__auto__)

True if an instance of LocalTime.

True if an instance of LocalTime.
sourceraw docstring

max

(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
sourceraw docstring

max-value

(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
sourceraw docstring

micros

(micros micros)

Duration of a specified number of microseconds.

Duration of a specified number of microseconds.
sourceraw docstring

millis

(millis v__3244__auto__)

Duration of a specified number of millis.

Duration of a specified number of millis.
sourceraw docstring

min

(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
sourceraw docstring

min-value

(min-value p)

Minimum value of this property

Minimum value of this property
sourceraw docstring

minus

(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">
sourceraw docstring

minutes

(minutes v__3244__auto__)

Duration of a specified number of minutes.

Duration of a specified number of minutes.
sourceraw docstring

mock-clock

(mock-clock)
(mock-clock instant)
(mock-clock instant zone)

Returns a mock implementation of the java.time.Clock. The mock supports advance-clock! operation which allows to move the time in the clock, e.g.:

(let [clock (mock-clock 0 "UTC")] (with-clock clock (is (= (value clock) 0)) (is (= (instant) (instant 0))) (advance-clock! clock (j/millis 1)) (is (= (value clock) 1)) (is (= (instant) (instant 1)))))

You can move the clock back via advancing by a negative temporal amount.

Creates a clock at epoch in the default timezone when called without arguments.

Returns a mock implementation of the `java.time.Clock`. The mock supports
`advance-clock!` operation which allows to move the time in the clock, e.g.:

(let [clock (mock-clock 0 "UTC")]
  (with-clock clock
    (is (= (value clock) 0))
    (is (= (instant) (instant 0)))
    (advance-clock! clock (j/millis 1))
    (is (= (value clock) 1))
    (is (= (instant) (instant 1)))))

You can move the clock back via advancing by a negative temporal amount.

Creates a clock at epoch in the default timezone when called without arguments.
sourceraw docstring

monday?

(monday? o__4124__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.
sourceraw docstring

month

(month)
(month v__3806__auto__)
(month fmt__3807__auto__ arg__3808__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.
sourceraw docstring

month-day

(month-day)
(month-day G__3932)
(month-day a__3852__auto__ b__3853__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.
sourceraw docstring

month-day?

(month-day? o__3849__auto__)
source

month?

(month? o__3805__auto__)
source

months

(months v__3265__auto__)
source

move-end-by

(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)) => nil

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))
  => nil

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

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

move-end-to

(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)) => nil

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))
 => nil

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

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

move-start-by

(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)) => nil

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))
  => nil

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

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

move-start-to

(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)) => nil

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))
 => nil

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

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

multiply-by

(multiply-by o v)

Entity o mutlitplied by the value v

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

nanos

(nanos v__3244__auto__)

Duration of a specified number of nanos.

Duration of a specified number of nanos.
sourceraw docstring

negate

(negate a)

Negates a temporal amount:

(negate (negate x)) == x

Negates a temporal amount:

(negate (negate x)) == x
sourceraw docstring

negative?

(negative? a)

True if the amount is negative

True if the amount is negative
sourceraw docstring

offset-clock

(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`.
sourceraw docstring

offset-date-time

(offset-date-time)
(offset-date-time arg_1_3443)
(offset-date-time arg_1_3444 arg_2_3445)
(offset-date-time arg_1_3446 arg_2_3447 arg_3_3448)
(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)`.
sourceraw docstring

offset-date-time?

(offset-date-time? v__2344__auto__)

True if an instance of OffsetDateTime.

True if an instance of OffsetDateTime.
sourceraw docstring

offset-time

(offset-time)
(offset-time arg_1_3483)
(offset-time arg_1_3484 arg_2_3485)
(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)`.
sourceraw docstring

offset-time?

(offset-time? v__2344__auto__)

True if an instance of OffsetTime.

True if an instance of OffsetTime.
sourceraw docstring

overlap

(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`
sourceraw docstring

overlaps?

(overlaps? i oi)

True if this interval overlaps the other one

True if this interval overlaps the other one
sourceraw docstring

period

(period)
(period arg_1_3278)
(period arg_1_3279 arg_2_3280)
(period arg_1_3281 arg_2_3282 arg_3_3283)

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.
sourceraw docstring

period?

(period? v__2344__auto__)

True if an instance of Period.

True if an instance of Period.
sourceraw docstring

plus

(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">
sourceraw docstring

properties

(properties o)

Map of properties present in this temporal entity

Map of properties present in this temporal entity
sourceraw docstring

property

(property o k)

Property of this temporal entity under key k

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

quarter

(quarter)
(quarter v__3806__auto__)
(quarter fmt__3807__auto__ arg__3808__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.
sourceraw docstring

quarter?

(quarter? o__3805__auto__)
source

range

(range p)

Range of values for this property

Range of values for this property
sourceraw docstring

saturday?

(saturday? o__4124__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.
sourceraw docstring

seconds

(seconds v__3244__auto__)

Duration of a specified number of seconds.

Duration of a specified number of seconds.
sourceraw docstring

set-clock!

(set-clock! clock time)

Sets the clock to the given time.

This mutates the mock clock.

Sets the `clock` to the given `time`.

This mutates the mock clock.
sourceraw docstring

smallest-max-value

(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
sourceraw docstring

sql-date

(sql-date)
(sql-date G__4523)
(sql-date G__4524 G__4525)
(sql-date G__4526 G__4527 G__4528)

Creates a java.sql.Date out of any combination of arguments valid for java-time/local-date or the LocalDate itself.

Please consider using the JSR-310 Java Time types instead of java.sql.Date if your drivers support them.

Even though java.sql.Date extends a java.util.Date, it's supposed to be used as a local date (no time component or timezone) for the purposes of conversion from/to native JDBC driver DATE types.

Creates a `java.sql.Date` out of any combination of arguments valid for
`java-time/local-date` or the `LocalDate` itself.

Please consider using the JSR-310 Java Time types instead of `java.sql.Date`
if your drivers support them.

Even though `java.sql.Date` extends a `java.util.Date`, it's supposed to be
used as a local date (no time component or timezone) for the purposes of
conversion from/to native JDBC driver DATE types.
sourceraw docstring

sql-time

(sql-time)
(sql-time G__4560)
(sql-time G__4561 G__4562)
(sql-time G__4563 G__4564 G__4565)

Creates a java.sql.Time out of any combination of arguments valid for java-time/local-time (except the nanos constructor) or the LocalTime itself.

Please consider using the JSR-310 Java Time types instead of java.sql.Time if your drivers support them.

Even though java.sql.Time extends a java.util.Date, it's supposed to be used as a local time (no date component or timezone) for the purposes of conversion from/to native JDBC driver TIME types.

Creates a `java.sql.Time` out of any combination of arguments valid for
`java-time/local-time` (except the nanos constructor) or the `LocalTime`
itself.

Please consider using the JSR-310 Java Time types instead of `java.sql.Time`
if your drivers support them.

Even though `java.sql.Time` extends a `java.util.Date`, it's supposed to be
used as a local time (no date component or timezone) for the purposes of
conversion from/to native JDBC driver TIME types.
sourceraw docstring

sql-timestamp

(sql-timestamp)
(sql-timestamp G__4530)
(sql-timestamp G__4531 G__4532)
(sql-timestamp G__4533 G__4534 G__4535)
(sql-timestamp G__4536 G__4537 G__4538 G__4539)
(sql-timestamp G__4540 G__4541 G__4542 G__4543 G__4544)
(sql-timestamp G__4545 G__4546 G__4547 G__4548 G__4549 G__4550)
(sql-timestamp G__4551
               G__4552
               G__4553
               G__4554
               G__4555
               G__4556
               G__4557)

Creates a java.sql.Timestamp in the local timezone out of any combination of arguments valid for java-time/local-date-time or the LocalDateTime itself.

The sql-timestamp constructor function does not support Timestamp construction from an Instant or a long millis value. Please use instant->sql-timestamp for this purpose.

Please consider using the JSR-310 Java Time types instead of java.sql.Timestamp if your drivers support them.

java.sql.Timestamp is a version of a java.util.Date supposed to be used as a local date-time (no timezone) for the purposes of conversion from/to native JDBC driver TIMESTAMP types.

Creates a `java.sql.Timestamp` in the local timezone out of any combination
of arguments valid for `java-time/local-date-time` or the `LocalDateTime`
itself.

The `sql-timestamp` constructor function does not support `Timestamp`
construction from an `Instant` or a long millis value. Please use
`instant->sql-timestamp` for this purpose.

Please consider using the JSR-310 Java Time types instead of
`java.sql.Timestamp` if your drivers support them.

`java.sql.Timestamp` is a version of a `java.util.Date` supposed to be used
as a local date-time (no timezone) for the purposes of conversion from/to native
JDBC driver TIMESTAMP types.
sourceraw docstring

standard-days

(standard-days v__3244__auto__)

Duration of a specified number of days.

Duration of a specified number of days.
sourceraw docstring

start

(start i)

Gets the start instant of the interval

Gets the start instant of the interval
sourceraw docstring

sunday?

(sunday? o__4124__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.
sourceraw docstring

supports?

(supports? o p)

True if the o entity supports the p property

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

system-clock

(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.
sourceraw docstring

thursday?

(thursday? o__4124__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.
sourceraw docstring

tick-clock

(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.
sourceraw docstring

time-between

(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
sourceraw docstring

to-java-date

(to-java-date o)

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

Deprecated: This function only has a single arity and works for entities directly convertible to java.time.Instant. Please consider using java-date instead.

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

*Deprecated*:
This function only has a single arity and works for entities directly
convertible to `java.time.Instant`. Please consider using `java-date`
instead.
sourceraw docstring

to-millis-from-epoch

(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.
sourceraw docstring

to-sql-date

(to-sql-date o)

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

Deprecated: This function only has a single arity and works for entities directly convertible to java.time.LocalDate. Please consider using sql-date instead.

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

*Deprecated*:
This function only has a single arity and works for entities directly
convertible to `java.time.LocalDate`. Please consider using `sql-date`
instead.
sourceraw docstring

to-sql-timestamp

(to-sql-timestamp o)

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

Deprecated: This function only has a single arity and works for entities directly convertible to java.time.Instant. Please consider using sql-timestamp instead.

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

*Deprecated*:
This function only has a single arity and works for entities directly
convertible to `java.time.Instant`. Please consider using `sql-timestamp`
instead.
sourceraw docstring

truncate-to

(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`).
sourceraw docstring

tuesday?

(tuesday? o__4124__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.
sourceraw docstring

unit

(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`.
sourceraw docstring

unit?

(unit? o)

True if this is a TemporalUnit.

True if this is a `TemporalUnit`.
sourceraw docstring

units

(units o)

Units present in this temporal entity.

Units present in this temporal entity.
sourceraw docstring

value

(value p)

Value of the property

Value of the property
sourceraw docstring

value-range

(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`.
sourceraw docstring

wednesday?

(wednesday? o__4124__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.
sourceraw docstring

weekday?

(weekday? dt)
source

weekend?

(weekend? dt)
source

weeks

(weeks v__3265__auto__)
source

when-joda-time-loadedmacro

(when-joda-time-loaded & body)

Execute the body when Joda-Time classes are found on the classpath.

Take care - when AOT-compiling code using this macro, the Joda-Time classes must be on the classpath at compile time!

Execute the `body` when Joda-Time classes are found on the classpath.

Take care - when AOT-compiling code using this macro, the Joda-Time classes
must be on the classpath at compile time!
sourceraw docstring

with-clockmacro

(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)) => nil

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))
  => nil
sourceraw docstring

with-clock-fn

(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.
sourceraw docstring

with-largest-min-value

(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
sourceraw docstring

with-max-value

(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
sourceraw docstring

with-min-value

(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
sourceraw docstring

with-offset

(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) => nil (with-offset *1 +3) => nil

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

  (offset-time 10 30 0 0 +2)
  => nil
  (with-offset *1 +3)
  => nil
sourceraw docstring

with-offset-same-instant

(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) => nil (with-offset-same-instant *1 +3) => nil

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

(offset-time 10 30 0 0 +2)
=> nil
(with-offset-same-instant *1 +3)
=> nil
sourceraw docstring

with-smallest-max-value

(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
sourceraw docstring

with-value

(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`
sourceraw docstring

with-zone

(with-zone o z)

Returns this temporal entity with the specified ZoneId

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

with-zone-same-instant

(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) => nil (with-zone-same-instant *1 "America/New_York") => nil

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

(zoned-date-time 2015)
=> nil
(with-zone-same-instant *1 "America/New_York")
=> nil
sourceraw docstring

year

(year)
(year G__3921)
(year fmt__3839__auto__ arg__3840__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.
sourceraw docstring

year-month

(year-month)
(year-month G__3949)
(year-month a__3852__auto__ b__3853__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.
sourceraw docstring

year-month?

(year-month? o__3849__auto__)
source

year-quarter

(year-quarter)
(year-quarter G__4037)
(year-quarter a__3852__auto__ b__3853__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.
sourceraw docstring

year-quarter?

(year-quarter? o__3849__auto__)
source

year?

(year? o__3838__auto__)
source

years

(years v__3265__auto__)
source

zero?

(zero? a)

True if the amount is zero

True if the amount is zero
sourceraw docstring

zone-id

(zone-id)
(zone-id arg_1_3415)
(zone-id arg_1_3416 arg_2_3417)

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.
sourceraw docstring

zone-id?

(zone-id? v__2344__auto__)

True if an instance of ZoneId.

True if an instance of ZoneId.
sourceraw docstring

zone-offset

(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.
sourceraw docstring

zoned-date-time

(zoned-date-time)
(zoned-date-time arg_1_3510)
(zoned-date-time arg_1_3511 arg_2_3512)
(zoned-date-time arg_1_3513 arg_2_3514 arg_3_3515)
(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)`.
sourceraw docstring

zoned-date-time?

(zoned-date-time? v__2344__auto__)

True if an instance of ZonedDateTime.

True if an instance of ZonedDateTime.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close