joda-time.core — clojure.joda-time 0.7.0

after? clj

(after? x)

(after? x y)

(after? x y & more)

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

(after? (date-time "2011") (date-time "2010") (date-time "2009")) => true

(after? (interval (date-time "2009") (date-time "2010")) (date-time "2008")) => truthy...

Works with instants, date-times, partials and intervals.

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 as <):

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

(before? (interval (date-time "2009") (date-time "2010")) (date-time "2011")) => truthy...

Works with instants, date-times, partials and intervals.

chronology clj

(chronology nm)

(chronology nm tz)

Produces a chronology of the specified type (lowercase) and the given time zone (optional):

(chronology :coptic) => #<CopticChronology CopticChronology [Europe/Vilnius]>

(chronology :coptic :UTC) => #<CopticChronology CopticChronology [UTC]>

Time zones are resolved through the timezone function.

duration? clj

(duration? x)

True if the given object is an instance of ReadableDuration.

HasProperties clj protocol

properties clj

(properties o)

Retrieves properties of a Partial or a DateTime.

For example, get a date with the last day of month:

(-> (properties date) :dayOfMonth with-max-value)

or get maximum values for all of the properties:

(->> (properties date) (map (comp max-value val))

property clj

(property o key)

Retrieves a property with the given key. Nil if the property doesn't exist.

For example:

(-> date properties :dayOfMonth value)

can be achieved efficiently by:

(-> date (property :dayOfMonth) value)

HasSign clj protocol

abs clj

(abs o)

Returns the absolute value of a period or a duration.

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

negate clj

(negate o)

Negates a period or a duration.

(negate (negate x)) == x

HasZone clj protocol

with-zone clj

(with-zone o zone)

Set the time zone for the given date-time or a formatter. Argument zone might be a DateTimeZone or a (case-sensitive) name of the time zone.

instant? clj

(instant? x)

True if the given object is an instance of ReadableInstant.

interval? clj

(interval? x)

True if the given object is an instance of ReadableInterval.

max clj

(max o & os)

Maximum of the given date-times/instants/partials/periods/intervals.

merge clj

(merge o & os)

Merges two or more periods or partials together.

Periods

Merges periods together to produce a Period. Type of the resulting period is an aggregate of all period types participating in a merge.

Periods further in the arglist will overwrite earlier ones having overlapping period types.

(merge (years 2) (months 3)) => #<Period P2Y3M>

(merge (years 2) (years 3)) => #<Period P3Y>

Partials

Merges partials into an instance of Partial using the chronology of the first partial:

(merge (partial {:year 5}) (partial {:year 3, :monthOfYear 4})) => #<Partial 0003-04>

Will throw an exception if the resulting partial is invalid:

(merge (local-date "2008-02-29") (partial {:year 2010})) => Exception ...

Mergeable clj protocol

seq-merge clj

(seq-merge o objects)

Internal use only.

min clj

(min o & os)

Minimum of the given date-times/instants/partials/periods/intervals.

minus clj

(minus o & os)

Subtracts one or more time entity from the first entity. Minus is defined for the following entities:

• periods: period - {period, number}
• durations: duration - {duration, number}
• partials: partial - period
• instants: instant - {duration, period}

Calling minus with a single argument has the same effect as negate (for durations and periods). (minus x y z) has the same effect as (plus x (negate y) (negate z)).

Minusable clj protocol

seq-minus clj

(seq-minus o objects)

Internal use only.

Ordered clj protocol

single-after? clj

(single-after? a b)

Implementation details

single-before? clj

(single-before? a b)

Implementation details

partial? clj

(partial? x)

True if the given object is an instance of ReadablePartial (includes local dates/times).

period? clj

(period? x)

True if the given object is an instance of ReadablePeriod.

plus clj

(plus o & os)

Sums two or more time entities together. Plus is defined for the following entities:

• periods: period + {period, number}
• durations: duration + {duration, number}
• partials: partial + period
• instants: instant + {duration, period}

Periods

Sums periods and numbers together to produce a Period. No period normalization or field overflows happen in the plus function.

(plus (years 1) (years 1) (months 1)) => #<Period P2Y1M>

Numbers are only allowed if type of the sum of the periods preceding the number is single (e.g. years or months).

(plus (years 1) 10) => #<Period P11Y>

(plus (years 1) (months 1) 10) => Exception ...

(plus (years 1) 10 (months 1)) => #<Period P11Y1M>

Will always return the result of type Period, albeit with the most specific PeriodType.

Durations

Sums durations and numbers of milliseconds together to produce a Duration.

(plus (duration 10) (duration 10) 10) => #<Duration PT0.030S>

Partials

Sums a partial and periods together to produce a partial. Produces the most specific type:

(plus (local-date "2010-01-01") (years 2)) => #<LocalDate 2012-01-01>

(plus (partial {:year 2010}) (years 2)) => #<Partial 2012>

Discards periods which aren't supported by the partial:

(plus (partial {:year 2010}) (days 500)) => #<Partial 2010>

Instants

Sums an instant and periods, durations and numbers of milliseconds together to produce an instant. Works with Instants and DateTimes. Returns the most specific type:

(plus (date-time 0) 1000 (duration 1000) (years 40)) => #<DateTime 2010-01-01T03:00:02.000+02:00>

(plus (instant 0) 1000 (duration 1000) (years 40)) => #<Instant 2010-01-01T00:00:02.000Z>

Plusable clj protocol

seq-plus clj

(seq-plus o objects)

Internal use only.

timezone clj

(timezone)

(timezone tz)

Produces a DateTimeZone out of a java.util.TimeZone or a timezone ID - a case-sensitive string, keyword or symbol:

(timezone :UTC) => #<FixedDateTimeZone UTC>

Default time zone is returned when called with no arguments:

(timezone) => #<CachedDateTimeZone Europe/Vilnius>