forked from dm3/clojure.java-time
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjava-time.html
More file actions
446 lines (363 loc) · 64.5 KB
/
java-time.html
File metadata and controls
446 lines (363 loc) · 64.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>java-time documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure.java-time</span> <span class="project-version">0.3.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="README.html"><div class="inner"><span>Clojure.Java-Time</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="java-time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>java-time</span></div></a></li><li class="depth-2"><a href="java-time.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="java-time.html#var-abs"><div class="inner"><span>abs</span></div></a></li><li class="depth-1"><a href="java-time.html#var-abuts.3F"><div class="inner"><span>abuts?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-adjust"><div class="inner"><span>adjust</span></div></a></li><li class="depth-1"><a href="java-time.html#var-after.3F"><div class="inner"><span>after?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-am-pm"><div class="inner"><span>am-pm</span></div></a></li><li class="depth-1"><a href="java-time.html#var-am-pm.3F"><div class="inner"><span>am-pm?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-as"><div class="inner"><span>as</span></div></a></li><li class="depth-1"><a href="java-time.html#var-as-map"><div class="inner"><span>as-map</span></div></a></li><li class="depth-1"><a href="java-time.html#var-available-zone-ids"><div class="inner"><span>available-zone-ids</span></div></a></li><li class="depth-1"><a href="java-time.html#var-before.3F"><div class="inner"><span>before?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-chronology"><div class="inner"><span>chronology</span></div></a></li><li class="depth-1"><a href="java-time.html#var-contains.3F"><div class="inner"><span>contains?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-convert-amount"><div class="inner"><span>convert-amount</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-month"><div class="inner"><span>day-of-month</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-month.3F"><div class="inner"><span>day-of-month?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-week"><div class="inner"><span>day-of-week</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-week.3F"><div class="inner"><span>day-of-week?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-year"><div class="inner"><span>day-of-year</span></div></a></li><li class="depth-1"><a href="java-time.html#var-day-of-year.3F"><div class="inner"><span>day-of-year?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-days"><div class="inner"><span>days</span></div></a></li><li class="depth-1"><a href="java-time.html#var-duration"><div class="inner"><span>duration</span></div></a></li><li class="depth-1"><a href="java-time.html#var-duration.3F"><div class="inner"><span>duration?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-end"><div class="inner"><span>end</span></div></a></li><li class="depth-1"><a href="java-time.html#var-field"><div class="inner"><span>field</span></div></a></li><li class="depth-1"><a href="java-time.html#var-field.3F"><div class="inner"><span>field?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-fields"><div class="inner"><span>fields</span></div></a></li><li class="depth-1"><a href="java-time.html#var-fixed-clock"><div class="inner"><span>fixed-clock</span></div></a></li><li class="depth-1"><a href="java-time.html#var-format"><div class="inner"><span>format</span></div></a></li><li class="depth-1"><a href="java-time.html#var-formatter"><div class="inner"><span>formatter</span></div></a></li><li class="depth-1"><a href="java-time.html#var-friday.3F"><div class="inner"><span>friday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-gap"><div class="inner"><span>gap</span></div></a></li><li class="depth-1"><a href="java-time.html#var-hours"><div class="inner"><span>hours</span></div></a></li><li class="depth-1"><a href="java-time.html#var-instant"><div class="inner"><span>instant</span></div></a></li><li class="depth-1"><a href="java-time.html#var-instant.3F"><div class="inner"><span>instant?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-interval"><div class="inner"><span>interval</span></div></a></li><li class="depth-1"><a href="java-time.html#var-interval.3F"><div class="inner"><span>interval?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-iterate"><div class="inner"><span>iterate</span></div></a></li><li class="depth-1"><a href="java-time.html#var-java-date"><div class="inner"><span>java-date</span></div></a></li><li class="depth-1"><a href="java-time.html#var-largest-min-value"><div class="inner"><span>largest-min-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-leap.3F"><div class="inner"><span>leap?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-date"><div class="inner"><span>local-date</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-date-time"><div class="inner"><span>local-date-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-date-time.3F"><div class="inner"><span>local-date-time?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-date.3F"><div class="inner"><span>local-date?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-time"><div class="inner"><span>local-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-local-time.3F"><div class="inner"><span>local-time?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-max"><div class="inner"><span>max</span></div></a></li><li class="depth-1"><a href="java-time.html#var-max-value"><div class="inner"><span>max-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-micros"><div class="inner"><span>micros</span></div></a></li><li class="depth-1"><a href="java-time.html#var-millis"><div class="inner"><span>millis</span></div></a></li><li class="depth-1"><a href="java-time.html#var-min"><div class="inner"><span>min</span></div></a></li><li class="depth-1"><a href="java-time.html#var-min-value"><div class="inner"><span>min-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-minus"><div class="inner"><span>minus</span></div></a></li><li class="depth-1"><a href="java-time.html#var-minutes"><div class="inner"><span>minutes</span></div></a></li><li class="depth-1"><a href="java-time.html#var-monday.3F"><div class="inner"><span>monday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-month"><div class="inner"><span>month</span></div></a></li><li class="depth-1"><a href="java-time.html#var-month-day"><div class="inner"><span>month-day</span></div></a></li><li class="depth-1"><a href="java-time.html#var-month-day.3F"><div class="inner"><span>month-day?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-month.3F"><div class="inner"><span>month?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-months"><div class="inner"><span>months</span></div></a></li><li class="depth-1"><a href="java-time.html#var-move-end-by"><div class="inner"><span>move-end-by</span></div></a></li><li class="depth-1"><a href="java-time.html#var-move-end-to"><div class="inner"><span>move-end-to</span></div></a></li><li class="depth-1"><a href="java-time.html#var-move-start-by"><div class="inner"><span>move-start-by</span></div></a></li><li class="depth-1"><a href="java-time.html#var-move-start-to"><div class="inner"><span>move-start-to</span></div></a></li><li class="depth-1"><a href="java-time.html#var-multiply-by"><div class="inner"><span>multiply-by</span></div></a></li><li class="depth-1"><a href="java-time.html#var-nanos"><div class="inner"><span>nanos</span></div></a></li><li class="depth-1"><a href="java-time.html#var-negate"><div class="inner"><span>negate</span></div></a></li><li class="depth-1"><a href="java-time.html#var-negative.3F"><div class="inner"><span>negative?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-offset-clock"><div class="inner"><span>offset-clock</span></div></a></li><li class="depth-1"><a href="java-time.html#var-offset-date-time"><div class="inner"><span>offset-date-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-offset-date-time.3F"><div class="inner"><span>offset-date-time?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-offset-time"><div class="inner"><span>offset-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-offset-time.3F"><div class="inner"><span>offset-time?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-overlap"><div class="inner"><span>overlap</span></div></a></li><li class="depth-1"><a href="java-time.html#var-overlaps.3F"><div class="inner"><span>overlaps?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-period"><div class="inner"><span>period</span></div></a></li><li class="depth-1"><a href="java-time.html#var-period.3F"><div class="inner"><span>period?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-plus"><div class="inner"><span>plus</span></div></a></li><li class="depth-1"><a href="java-time.html#var-properties"><div class="inner"><span>properties</span></div></a></li><li class="depth-1"><a href="java-time.html#var-property"><div class="inner"><span>property</span></div></a></li><li class="depth-1"><a href="java-time.html#var-quarter"><div class="inner"><span>quarter</span></div></a></li><li class="depth-1"><a href="java-time.html#var-quarter.3F"><div class="inner"><span>quarter?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-range"><div class="inner"><span>range</span></div></a></li><li class="depth-1"><a href="java-time.html#var-saturday.3F"><div class="inner"><span>saturday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-seconds"><div class="inner"><span>seconds</span></div></a></li><li class="depth-1"><a href="java-time.html#var-smallest-max-value"><div class="inner"><span>smallest-max-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-sql-date"><div class="inner"><span>sql-date</span></div></a></li><li class="depth-1"><a href="java-time.html#var-sql-time"><div class="inner"><span>sql-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-sql-timestamp"><div class="inner"><span>sql-timestamp</span></div></a></li><li class="depth-1"><a href="java-time.html#var-standard-days"><div class="inner"><span>standard-days</span></div></a></li><li class="depth-1"><a href="java-time.html#var-start"><div class="inner"><span>start</span></div></a></li><li class="depth-1"><a href="java-time.html#var-sunday.3F"><div class="inner"><span>sunday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-supports.3F"><div class="inner"><span>supports?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-system-clock"><div class="inner"><span>system-clock</span></div></a></li><li class="depth-1"><a href="java-time.html#var-thursday.3F"><div class="inner"><span>thursday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-tick-clock"><div class="inner"><span>tick-clock</span></div></a></li><li class="depth-1"><a href="java-time.html#var-time-between"><div class="inner"><span>time-between</span></div></a></li><li class="depth-1"><a href="java-time.html#var-to-java-date"><div class="inner"><span>to-java-date</span></div></a></li><li class="depth-1"><a href="java-time.html#var-to-millis-from-epoch"><div class="inner"><span>to-millis-from-epoch</span></div></a></li><li class="depth-1"><a href="java-time.html#var-to-sql-date"><div class="inner"><span>to-sql-date</span></div></a></li><li class="depth-1"><a href="java-time.html#var-to-sql-timestamp"><div class="inner"><span>to-sql-timestamp</span></div></a></li><li class="depth-1"><a href="java-time.html#var-truncate-to"><div class="inner"><span>truncate-to</span></div></a></li><li class="depth-1"><a href="java-time.html#var-tuesday.3F"><div class="inner"><span>tuesday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-unit"><div class="inner"><span>unit</span></div></a></li><li class="depth-1"><a href="java-time.html#var-unit.3F"><div class="inner"><span>unit?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-units"><div class="inner"><span>units</span></div></a></li><li class="depth-1"><a href="java-time.html#var-value"><div class="inner"><span>value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-value-range"><div class="inner"><span>value-range</span></div></a></li><li class="depth-1"><a href="java-time.html#var-wednesday.3F"><div class="inner"><span>wednesday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-weekday.3F"><div class="inner"><span>weekday?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-weekend.3F"><div class="inner"><span>weekend?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-weeks"><div class="inner"><span>weeks</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-clock"><div class="inner"><span>with-clock</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-clock-fn"><div class="inner"><span>with-clock-fn</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-largest-min-value"><div class="inner"><span>with-largest-min-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-max-value"><div class="inner"><span>with-max-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-min-value"><div class="inner"><span>with-min-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-offset"><div class="inner"><span>with-offset</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-offset-same-instant"><div class="inner"><span>with-offset-same-instant</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-smallest-max-value"><div class="inner"><span>with-smallest-max-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-value"><div class="inner"><span>with-value</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-zone"><div class="inner"><span>with-zone</span></div></a></li><li class="depth-1"><a href="java-time.html#var-with-zone-same-instant"><div class="inner"><span>with-zone-same-instant</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year"><div class="inner"><span>year</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year-month"><div class="inner"><span>year-month</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year-month.3F"><div class="inner"><span>year-month?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year-quarter"><div class="inner"><span>year-quarter</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year-quarter.3F"><div class="inner"><span>year-quarter?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-year.3F"><div class="inner"><span>year?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-years"><div class="inner"><span>years</span></div></a></li><li class="depth-1"><a href="java-time.html#var-zero.3F"><div class="inner"><span>zero?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-zone-id"><div class="inner"><span>zone-id</span></div></a></li><li class="depth-1"><a href="java-time.html#var-zone-offset"><div class="inner"><span>zone-offset</span></div></a></li><li class="depth-1"><a href="java-time.html#var-zoned-date-time"><div class="inner"><span>zoned-date-time</span></div></a></li><li class="depth-1"><a href="java-time.html#var-zoned-date-time.3F"><div class="inner"><span>zoned-date-time?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">java-time</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-abs"><h3>abs</h3><div class="usage"><code>(abs a)</code></div><div class="doc"><pre class="plaintext">Returns the absolute value of a temporal amount:
(abs (negate x)) == (abs x)</pre></div></div><div class="public anchor" id="var-abuts.3F"><h3>abuts?</h3><div class="usage"><code>(abuts? i oi)</code></div><div class="doc"><pre class="plaintext">True if this interval abut with the other one
</pre></div></div><div class="public anchor" id="var-adjust"><h3>adjust</h3><div class="usage"><code>(adjust entity adjuster & args)</code></div><div class="doc"><pre class="plaintext">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></pre></div></div><div class="public anchor" id="var-after.3F"><h3>after?</h3><div class="usage"><code>(after? x)</code><code>(after? x y)</code><code>(after? x y & more)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-am-pm"><h3>am-pm</h3><div class="usage"><code>(am-pm)</code><code>(am-pm v__8876__auto__)</code><code>(am-pm fmt__8877__auto__ arg__8878__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `AmPm` for the given keyword name (`:am` or `:pm`),
ordinal or entity. Current AM/PM if no arguments given.</pre></div></div><div class="public anchor" id="var-am-pm.3F"><h3>am-pm?</h3><div class="usage"><code>(am-pm? o__8875__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-as"><h3>as</h3><div class="usage"><code>(as o k)</code><code>(as o k1 k2)</code><code>(as o k1 k2 & ks)</code></div><div class="doc"><pre class="plaintext">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]</pre></div></div><div class="public anchor" id="var-as-map"><h3>as-map</h3><div class="usage"><code>(as-map e)</code><code>(as-map e value-fn)</code></div><div class="doc"><pre class="plaintext">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, ...}</pre></div></div><div class="public anchor" id="var-available-zone-ids"><h3>available-zone-ids</h3><div class="usage"><code>(available-zone-ids)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-before.3F"><h3>before?</h3><div class="usage"><code>(before? x)</code><code>(before? x y)</code><code>(before? x y & more)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-chronology"><h3>chronology</h3><div class="usage"><code>(chronology o)</code></div><div class="doc"><pre class="plaintext">The `Chronology` of the entity
</pre></div></div><div class="public anchor" id="var-contains.3F"><h3>contains?</h3><div class="usage"><code>(contains? i o)</code></div><div class="doc"><pre class="plaintext">True if the interval contains the given instant or interval
</pre></div></div><div class="public anchor" id="var-convert-amount"><h3>convert-amount</h3><div class="usage"><code>(convert-amount amount from-unit to-unit)</code></div><div class="doc"><pre class="plaintext">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}</pre></div></div><div class="public anchor" id="var-day-of-month"><h3>day-of-month</h3><div class="usage"><code>(day-of-month)</code><code>(day-of-month G__9071)</code><code>(day-of-month fmt__8905__auto__ arg__8906__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `DayOfMonth` for the given entity, clock, zone or day of month.
Current day of month if no arguments given.</pre></div></div><div class="public anchor" id="var-day-of-month.3F"><h3>day-of-month?</h3><div class="usage"><code>(day-of-month? o__8904__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-day-of-week"><h3>day-of-week</h3><div class="usage"><code>(day-of-week)</code><code>(day-of-week v__8876__auto__)</code><code>(day-of-week fmt__8877__auto__ arg__8878__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `DayOfWeek` for the given day keyword name (e.g. `:monday`),
ordinal or entity. Current day if no arguments given.</pre></div></div><div class="public anchor" id="var-day-of-week.3F"><h3>day-of-week?</h3><div class="usage"><code>(day-of-week? o__8875__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-day-of-year"><h3>day-of-year</h3><div class="usage"><code>(day-of-year)</code><code>(day-of-year G__9082)</code><code>(day-of-year fmt__8905__auto__ arg__8906__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `DayOfYear` for the given entity, clock, zone or day of year.
Current day of year if no arguments given.</pre></div></div><div class="public anchor" id="var-day-of-year.3F"><h3>day-of-year?</h3><div class="usage"><code>(day-of-year? o__8904__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-days"><h3>days</h3><div class="usage"><code>(days v__8370__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-duration"><h3>duration</h3><div class="usage"><code>(duration)</code><code>(duration arg_1_8331)</code><code>(duration arg_1_8332 arg_2_8333)</code></div><div class="doc"><pre class="plaintext">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)`</pre></div></div><div class="public anchor" id="var-duration.3F"><h3>duration?</h3><div class="usage"><code>(duration? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of Duration.
</pre></div></div><div class="public anchor" id="var-end"><h3>end</h3><div class="usage"><code>(end i)</code></div><div class="doc"><pre class="plaintext">Gets the end instant of the interval
</pre></div></div><div class="public anchor" id="var-field"><h3>field</h3><div class="usage"><code>(field k)</code><code>(field entity k)</code></div><div class="doc"><pre class="plaintext">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`.</pre></div></div><div class="public anchor" id="var-field.3F"><h3>field?</h3><div class="usage"><code>(field? o)</code></div><div class="doc"><pre class="plaintext">True if this is a `TemporalField`.
</pre></div></div><div class="public anchor" id="var-fields"><h3>fields</h3><div class="usage"><code>(fields o)</code></div><div class="doc"><pre class="plaintext">Fields present in this temporal entity
</pre></div></div><div class="public anchor" id="var-fixed-clock"><h3>fixed-clock</h3><div class="usage"><code>(fixed-clock)</code><code>(fixed-clock i)</code><code>(fixed-clock i z)</code></div><div class="doc"><pre class="plaintext">Creates a fixed clock either at the current instant or at the supplied
instant/instant + zone.</pre></div></div><div class="public anchor" id="var-format"><h3>format</h3><div class="usage"><code>(format o)</code><code>(format fmt o)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-formatter"><h3>formatter</h3><div class="usage"><code>(formatter fmt)</code><code>(formatter fmt {:keys [resolver-style]})</code></div><div class="doc"><pre class="plaintext">Constructs a DateTimeFormatter out of a
* format string - "YYYY/mm/DD", "YYY HH:MM", etc.
* formatter name - :iso-date, :iso-time, etc.
- More examples can be found <a href="https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html">here</a>
Accepts a map of options as an optional second argument:
* `resolver-style` - either `:strict`, `:smart `or `:lenient`</pre></div></div><div class="public anchor" id="var-friday.3F"><h3>friday?</h3><div class="usage"><code>(friday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a friday.</pre></div></div><div class="public anchor" id="var-gap"><h3>gap</h3><div class="usage"><code>(gap i oi)</code></div><div class="doc"><pre class="plaintext">Gets the gap between this interval and the other one or `nil`
</pre></div></div><div class="public anchor" id="var-hours"><h3>hours</h3><div class="usage"><code>(hours v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of hours.
</pre></div></div><div class="public anchor" id="var-instant"><h3>instant</h3><div class="usage"><code>(instant)</code><code>(instant arg_1_8005)</code><code>(instant arg_1_8006 arg_2_8007)</code></div><div class="doc"><pre class="plaintext">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</pre></div></div><div class="public anchor" id="var-instant.3F"><h3>instant?</h3><div class="usage"><code>(instant? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of Instant.
</pre></div></div><div class="public anchor" id="var-interval"><h3>interval</h3><div class="usage"><code>(interval o)</code><code>(interval a b)</code></div><div class="doc"><pre class="plaintext">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></pre></div></div><div class="public anchor" id="var-interval.3F"><h3>interval?</h3><div class="usage"><code>(interval? o)</code></div><div class="doc"><pre class="plaintext">True if `Interval`
</pre></div></div><div class="public anchor" id="var-iterate"><h3>iterate</h3><div class="usage"><code>(iterate f initial v & vs)</code></div><div class="doc"><pre class="plaintext">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> ...)</pre></div></div><div class="public anchor" id="var-java-date"><h3>java-date</h3><div class="usage"><code>(java-date)</code><code>(java-date a)</code><code>(java-date a b)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-largest-min-value"><h3>largest-min-value</h3><div class="usage"><code>(largest-min-value p)</code></div><div class="doc"><pre class="plaintext">Largest minimum value of this property
</pre></div></div><div class="public anchor" id="var-leap.3F"><h3>leap?</h3><div class="usage"><code>(leap? o)</code></div><div class="doc"><pre class="plaintext">True if the year of this entity is a leap year.
</pre></div></div><div class="public anchor" id="var-local-date"><h3>local-date</h3><div class="usage"><code>(local-date)</code><code>(local-date arg_1_8052)</code><code>(local-date arg_1_8053 arg_2_8054)</code><code>(local-date arg_1_8055 arg_2_8056 arg_3_8057)</code></div><div class="doc"><pre class="plaintext">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</pre></div></div><div class="public anchor" id="var-local-date-time"><h3>local-date-time</h3><div class="usage"><code>(local-date-time)</code><code>(local-date-time y m d h)</code><code>(local-date-time y m d h mm)</code><code>(local-date-time y m d h mm ss)</code><code>(local-date-time y m d h mm ss n)</code><code>(local-date-time arg_1_8120)</code><code>(local-date-time arg_1_8121 arg_2_8122)</code><code>(local-date-time arg_1_8123 arg_2_8124 arg_3_8125)</code></div><div class="doc"><pre class="plaintext">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/...</pre></div></div><div class="public anchor" id="var-local-date-time.3F"><h3>local-date-time?</h3><div class="usage"><code>(local-date-time? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of LocalDateTime.
</pre></div></div><div class="public anchor" id="var-local-date.3F"><h3>local-date?</h3><div class="usage"><code>(local-date? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of LocalDate.
</pre></div></div><div class="public anchor" id="var-local-time"><h3>local-time</h3><div class="usage"><code>(local-time)</code><code>(local-time h m s nn)</code><code>(local-time arg_1_8086)</code><code>(local-time arg_1_8087 arg_2_8088)</code><code>(local-time arg_1_8089 arg_2_8090 arg_3_8091)</code></div><div class="doc"><pre class="plaintext">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</pre></div></div><div class="public anchor" id="var-local-time.3F"><h3>local-time?</h3><div class="usage"><code>(local-time? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of LocalTime.
</pre></div></div><div class="public anchor" id="var-max"><h3>max</h3><div class="usage"><code>(max o & os)</code></div><div class="doc"><pre class="plaintext">Latest/longest of the given time entities. Entities should be of the same
type</pre></div></div><div class="public anchor" id="var-max-value"><h3>max-value</h3><div class="usage"><code>(max-value p)</code></div><div class="doc"><pre class="plaintext">Maximum value of this property, e.g. 29th of February for months
</pre></div></div><div class="public anchor" id="var-micros"><h3>micros</h3><div class="usage"><code>(micros micros)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of microseconds.
</pre></div></div><div class="public anchor" id="var-millis"><h3>millis</h3><div class="usage"><code>(millis v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of millis.
</pre></div></div><div class="public anchor" id="var-min"><h3>min</h3><div class="usage"><code>(min o & os)</code></div><div class="doc"><pre class="plaintext">Earliest/shortest of the given time entities. Entities should be of the same
type</pre></div></div><div class="public anchor" id="var-min-value"><h3>min-value</h3><div class="usage"><code>(min-value p)</code></div><div class="doc"><pre class="plaintext">Minimum value of this property
</pre></div></div><div class="public anchor" id="var-minus"><h3>minus</h3><div class="usage"><code>(minus o & os)</code></div><div class="doc"><pre class="plaintext">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"></pre></div></div><div class="public anchor" id="var-minutes"><h3>minutes</h3><div class="usage"><code>(minutes v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of minutes.
</pre></div></div><div class="public anchor" id="var-monday.3F"><h3>monday?</h3><div class="usage"><code>(monday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a monday.</pre></div></div><div class="public anchor" id="var-month"><h3>month</h3><div class="usage"><code>(month)</code><code>(month v__8876__auto__)</code><code>(month fmt__8877__auto__ arg__8878__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `Month` for the given month keyword name (e.g. `:january`),
ordinal or entity. Current month if no arguments given.</pre></div></div><div class="public anchor" id="var-month-day"><h3>month-day</h3><div class="usage"><code>(month-day)</code><code>(month-day G__8993)</code><code>(month-day a__8918__auto__ b__8919__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `MonthDay` for the given entity, string, clock, zone or
month/day combination. Current month-day if no arguments given.</pre></div></div><div class="public anchor" id="var-month-day.3F"><h3>month-day?</h3><div class="usage"><code>(month-day? o__8915__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-month.3F"><h3>month?</h3><div class="usage"><code>(month? o__8875__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-months"><h3>months</h3><div class="usage"><code>(months v__8370__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-move-end-by"><h3>move-end-by</h3><div class="usage"><code>(move-end-by i & os)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-move-end-to"><h3>move-end-to</h3><div class="usage"><code>(move-end-to i new-end)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-move-start-by"><h3>move-start-by</h3><div class="usage"><code>(move-start-by i & os)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-move-start-to"><h3>move-start-to</h3><div class="usage"><code>(move-start-to i new-start)</code></div><div class="doc"><pre class="plaintext">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...</pre></div></div><div class="public anchor" id="var-multiply-by"><h3>multiply-by</h3><div class="usage"><code>(multiply-by o v)</code></div><div class="doc"><pre class="plaintext">Entity `o` mutlitplied by the value `v`
</pre></div></div><div class="public anchor" id="var-nanos"><h3>nanos</h3><div class="usage"><code>(nanos v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of nanos.
</pre></div></div><div class="public anchor" id="var-negate"><h3>negate</h3><div class="usage"><code>(negate a)</code></div><div class="doc"><pre class="plaintext">Negates a temporal amount:
(negate (negate x)) == x</pre></div></div><div class="public anchor" id="var-negative.3F"><h3>negative?</h3><div class="usage"><code>(negative? a)</code></div><div class="doc"><pre class="plaintext">True if the amount is negative
</pre></div></div><div class="public anchor" id="var-offset-clock"><h3>offset-clock</h3><div class="usage"><code>(offset-clock d)</code><code>(offset-clock c d)</code></div><div class="doc"><pre class="plaintext">Creates a clock offset from the current/provided clock by a given
`duration`.</pre></div></div><div class="public anchor" id="var-offset-date-time"><h3>offset-date-time</h3><div class="usage"><code>(offset-date-time)</code><code>(offset-date-time y m d h)</code><code>(offset-date-time y mo d h m)</code><code>(offset-date-time y mo d h m s)</code><code>(offset-date-time y mo d h m s n)</code><code>(offset-date-time y mo d h m s n o)</code><code>(offset-date-time arg_1_8536)</code><code>(offset-date-time arg_1_8537 arg_2_8538)</code><code>(offset-date-time arg_1_8539 arg_2_8540 arg_3_8541)</code></div><div class="doc"><pre class="plaintext">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)`.</pre></div></div><div class="public anchor" id="var-offset-date-time.3F"><h3>offset-date-time?</h3><div class="usage"><code>(offset-date-time? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of OffsetDateTime.
</pre></div></div><div class="public anchor" id="var-offset-time"><h3>offset-time</h3><div class="usage"><code>(offset-time)</code><code>(offset-time h m s)</code><code>(offset-time h m s n)</code><code>(offset-time h m s n o)</code><code>(offset-time arg_1_8570)</code><code>(offset-time arg_1_8571 arg_2_8572)</code></div><div class="doc"><pre class="plaintext">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)`.</pre></div></div><div class="public anchor" id="var-offset-time.3F"><h3>offset-time?</h3><div class="usage"><code>(offset-time? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of OffsetTime.
</pre></div></div><div class="public anchor" id="var-overlap"><h3>overlap</h3><div class="usage"><code>(overlap i oi)</code></div><div class="doc"><pre class="plaintext">Gets the overlap between this interval and the other one or `nil`
</pre></div></div><div class="public anchor" id="var-overlaps.3F"><h3>overlaps?</h3><div class="usage"><code>(overlaps? i oi)</code></div><div class="doc"><pre class="plaintext">True if this interval overlaps the other one
</pre></div></div><div class="public anchor" id="var-period"><h3>period</h3><div class="usage"><code>(period)</code><code>(period arg_1_8383)</code><code>(period arg_1_8384 arg_2_8385)</code><code>(period arg_1_8386 arg_2_8387 arg_3_8388)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-period.3F"><h3>period?</h3><div class="usage"><code>(period? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of Period.
</pre></div></div><div class="public anchor" id="var-plus"><h3>plus</h3><div class="usage"><code>(plus o & os)</code></div><div class="doc"><pre class="plaintext">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"></pre></div></div><div class="public anchor" id="var-properties"><h3>properties</h3><div class="usage"><code>(properties o)</code></div><div class="doc"><pre class="plaintext">Map of properties present in this temporal entity
</pre></div></div><div class="public anchor" id="var-property"><h3>property</h3><div class="usage"><code>(property o k)</code></div><div class="doc"><pre class="plaintext">Property of this temporal entity under key `k`
</pre></div></div><div class="public anchor" id="var-quarter"><h3>quarter</h3><div class="usage"><code>(quarter)</code><code>(quarter v__8876__auto__)</code><code>(quarter fmt__8877__auto__ arg__8878__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `Quarter` for the given quarter keyword name (e.g. `:q1`),
ordinal or entity. Current quarter if no arguments given.</pre></div></div><div class="public anchor" id="var-quarter.3F"><h3>quarter?</h3><div class="usage"><code>(quarter? o__8875__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-range"><h3>range</h3><div class="usage"><code>(range p)</code></div><div class="doc"><pre class="plaintext">Range of values for this property
</pre></div></div><div class="public anchor" id="var-saturday.3F"><h3>saturday?</h3><div class="usage"><code>(saturday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a saturday.</pre></div></div><div class="public anchor" id="var-seconds"><h3>seconds</h3><div class="usage"><code>(seconds v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of seconds.
</pre></div></div><div class="public anchor" id="var-smallest-max-value"><h3>smallest-max-value</h3><div class="usage"><code>(smallest-max-value p)</code></div><div class="doc"><pre class="plaintext">Smallest maximum value of this property, e.g. 28th of February for months
</pre></div></div><div class="public anchor" id="var-sql-date"><h3>sql-date</h3><div class="usage"><code>(sql-date)</code><code>(sql-date G__9570)</code><code>(sql-date G__9571 G__9572)</code><code>(sql-date G__9573 G__9574 G__9575)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-sql-time"><h3>sql-time</h3><div class="usage"><code>(sql-time)</code><code>(sql-time G__9606)</code><code>(sql-time G__9607 G__9608)</code><code>(sql-time G__9609 G__9610 G__9611)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-sql-timestamp"><h3>sql-timestamp</h3><div class="usage"><code>(sql-timestamp)</code><code>(sql-timestamp G__9577)</code><code>(sql-timestamp G__9578 G__9579)</code><code>(sql-timestamp G__9580 G__9581 G__9582)</code><code>(sql-timestamp G__9583 G__9584 G__9585 G__9586)</code><code>(sql-timestamp G__9587 G__9588 G__9589 G__9590 G__9591)</code><code>(sql-timestamp G__9592 G__9593 G__9594 G__9595 G__9596 G__9597)</code><code>(sql-timestamp G__9598 G__9599 G__9600 G__9601 G__9602 G__9603 G__9604)</code></div><div class="doc"><pre class="plaintext">Creates a `java.sql.Timestamp` out of any combination of arguments valid for
`java-time/local-date-time` or the LocalDateTime itself.
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.</pre></div></div><div class="public anchor" id="var-standard-days"><h3>standard-days</h3><div class="usage"><code>(standard-days v__8353__auto__)</code></div><div class="doc"><pre class="plaintext">Duration of a specified number of days.
</pre></div></div><div class="public anchor" id="var-start"><h3>start</h3><div class="usage"><code>(start i)</code></div><div class="doc"><pre class="plaintext">Gets the start instant of the interval
</pre></div></div><div class="public anchor" id="var-sunday.3F"><h3>sunday?</h3><div class="usage"><code>(sunday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a sunday.</pre></div></div><div class="public anchor" id="var-supports.3F"><h3>supports?</h3><div class="usage"><code>(supports? o p)</code></div><div class="doc"><pre class="plaintext">True if the `o` entity supports the `p` property
</pre></div></div><div class="public anchor" id="var-system-clock"><h3>system-clock</h3><div class="usage"><code>(system-clock)</code><code>(system-clock k)</code></div><div class="doc"><pre class="plaintext">Creates a system clock. In the default timezone if called without arguments,
otherwise accepts a Zone Id.</pre></div></div><div class="public anchor" id="var-thursday.3F"><h3>thursday?</h3><div class="usage"><code>(thursday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a thursday.</pre></div></div><div class="public anchor" id="var-tick-clock"><h3>tick-clock</h3><div class="usage"><code>(tick-clock d)</code><code>(tick-clock c d)</code></div><div class="doc"><pre class="plaintext">Creates a clock wrapping system/provided clock that only ticks as per
specified duration.</pre></div></div><div class="public anchor" id="var-time-between"><h3>time-between</h3><div class="usage"><code>(time-between o e u)</code></div><div class="doc"><pre class="plaintext">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</pre></div></div><div class="public anchor" id="var-to-java-date"><h3>to-java-date</h3><div class="usage"><code>(to-java-date o)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-to-millis-from-epoch"><h3>to-millis-from-epoch</h3><div class="usage"><code>(to-millis-from-epoch o)</code></div><div class="doc"><pre class="plaintext">Converts a date entity to a `long` representing the number of milliseconds
from epoch.</pre></div></div><div class="public anchor" id="var-to-sql-date"><h3>to-sql-date</h3><div class="usage"><code>(to-sql-date o)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-to-sql-timestamp"><h3>to-sql-timestamp</h3><div class="usage"><code>(to-sql-timestamp o)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-truncate-to"><h3>truncate-to</h3><div class="usage"><code>(truncate-to o u)</code></div><div class="doc"><pre class="plaintext">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`).</pre></div></div><div class="public anchor" id="var-tuesday.3F"><h3>tuesday?</h3><div class="usage"><code>(tuesday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a tuesday.</pre></div></div><div class="public anchor" id="var-unit"><h3>unit</h3><div class="usage"><code>(unit k)</code><code>(unit entity k)</code></div><div class="doc"><pre class="plaintext">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`.</pre></div></div><div class="public anchor" id="var-unit.3F"><h3>unit?</h3><div class="usage"><code>(unit? o)</code></div><div class="doc"><pre class="plaintext">True if this is a `TemporalUnit`.
</pre></div></div><div class="public anchor" id="var-units"><h3>units</h3><div class="usage"><code>(units o)</code></div><div class="doc"><pre class="plaintext">Units present in this temporal entity.
</pre></div></div><div class="public anchor" id="var-value"><h3>value</h3><div class="usage"><code>(value p)</code></div><div class="doc"><pre class="plaintext">Value of the property
</pre></div></div><div class="public anchor" id="var-value-range"><h3>value-range</h3><div class="usage"><code>(value-range min max)</code><code>(value-range {:keys [min-smallest min-largest max-smallest max-largest]})</code></div><div class="doc"><pre class="plaintext">Creates a `ValueRange` given the `min` and `max` amounts or a map of
`:min-smallest`, `:max-smallest`, `:min-largest` and `:max-largest`.</pre></div></div><div class="public anchor" id="var-wednesday.3F"><h3>wednesday?</h3><div class="usage"><code>(wednesday? o__9179__auto__)</code></div><div class="doc"><pre class="plaintext">Returns true if the given time entity with the
`day-of-week` property falls on a wednesday.</pre></div></div><div class="public anchor" id="var-weekday.3F"><h3>weekday?</h3><div class="usage"><code>(weekday? dt)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-weekend.3F"><h3>weekend?</h3><div class="usage"><code>(weekend? dt)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-weeks"><h3>weeks</h3><div class="usage"><code>(weeks v__8370__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-with-clock"><h3>with-clock</h3><h4 class="type">macro</h4><div class="usage"><code>(with-clock c & forms)</code></div><div class="doc"><pre class="plaintext">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></pre></div></div><div class="public anchor" id="var-with-clock-fn"><h3>with-clock-fn</h3><div class="usage"><code>(with-clock-fn c f)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-with-largest-min-value"><h3>with-largest-min-value</h3><div class="usage"><code>(with-largest-min-value p)</code></div><div class="doc"><pre class="plaintext">Underlying temporal entity with the value set to the largest minimum
available for this property</pre></div></div><div class="public anchor" id="var-with-max-value"><h3>with-max-value</h3><div class="usage"><code>(with-max-value p)</code></div><div class="doc"><pre class="plaintext">Underlying temporal entity with the value set to the maximum
available for this property</pre></div></div><div class="public anchor" id="var-with-min-value"><h3>with-min-value</h3><div class="usage"><code>(with-min-value p)</code></div><div class="doc"><pre class="plaintext">Underlying temporal entity with the value set to the minimum available for
this property</pre></div></div><div class="public anchor" id="var-with-offset"><h3>with-offset</h3><div class="usage"><code>(with-offset o offset)</code></div><div class="doc"><pre class="plaintext">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></pre></div></div><div class="public anchor" id="var-with-offset-same-instant"><h3>with-offset-same-instant</h3><div class="usage"><code>(with-offset-same-instant o offset)</code></div><div class="doc"><pre class="plaintext">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></pre></div></div><div class="public anchor" id="var-with-smallest-max-value"><h3>with-smallest-max-value</h3><div class="usage"><code>(with-smallest-max-value p)</code></div><div class="doc"><pre class="plaintext">Underlying temporal entity with the value set to the smallest maximum
available for this property</pre></div></div><div class="public anchor" id="var-with-value"><h3>with-value</h3><div class="usage"><code>(with-value p v)</code></div><div class="doc"><pre class="plaintext">Underlying temporal entity with the value of this property set to `v`
</pre></div></div><div class="public anchor" id="var-with-zone"><h3>with-zone</h3><div class="usage"><code>(with-zone o z)</code></div><div class="doc"><pre class="plaintext">Returns this temporal entity with the specified `ZoneId`
</pre></div></div><div class="public anchor" id="var-with-zone-same-instant"><h3>with-zone-same-instant</h3><div class="usage"><code>(with-zone-same-instant zdt z)</code></div><div class="doc"><pre class="plaintext">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]></pre></div></div><div class="public anchor" id="var-year"><h3>year</h3><div class="usage"><code>(year)</code><code>(year G__8982)</code><code>(year fmt__8905__auto__ arg__8906__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `Year` for the given entity, string, clock, zone or number.
Current year if no arguments given.</pre></div></div><div class="public anchor" id="var-year-month"><h3>year-month</h3><div class="usage"><code>(year-month)</code><code>(year-month G__9008)</code><code>(year-month a__8918__auto__ b__8919__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `YearMonth` for the given entity, string, clock, zone or
month/day combination. Current year-month if no arguments given.</pre></div></div><div class="public anchor" id="var-year-month.3F"><h3>year-month?</h3><div class="usage"><code>(year-month? o__8915__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-year-quarter"><h3>year-quarter</h3><div class="usage"><code>(year-quarter)</code><code>(year-quarter G__9094)</code><code>(year-quarter a__8918__auto__ b__8919__auto__)</code></div><div class="doc"><pre class="plaintext">Returns the `YearQuarter` for the given entity, clock, zone or year with quarter.
Current year quarter if no arguments given.</pre></div></div><div class="public anchor" id="var-year-quarter.3F"><h3>year-quarter?</h3><div class="usage"><code>(year-quarter? o__8915__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-year.3F"><h3>year?</h3><div class="usage"><code>(year? o__8904__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-years"><h3>years</h3><div class="usage"><code>(years v__8370__auto__)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-zero.3F"><h3>zero?</h3><div class="usage"><code>(zero? a)</code></div><div class="doc"><pre class="plaintext">True if the amount is zero
</pre></div></div><div class="public anchor" id="var-zone-id"><h3>zone-id</h3><div class="usage"><code>(zone-id)</code><code>(zone-id arg_1_8512)</code><code>(zone-id arg_1_8513 arg_2_8514)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-zone-offset"><h3>zone-offset</h3><div class="usage"><code>(zone-offset)</code><code>(zone-offset o)</code><code>(zone-offset h m)</code><code>(zone-offset h m s)</code></div><div class="doc"><pre class="plaintext">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.</pre></div></div><div class="public anchor" id="var-zoned-date-time"><h3>zoned-date-time</h3><div class="usage"><code>(zoned-date-time)</code><code>(zoned-date-time y m d h)</code><code>(zoned-date-time y mo d h m)</code><code>(zoned-date-time y mo d h m s)</code><code>(zoned-date-time y mo d h m s n)</code><code>(zoned-date-time y mo d h m s n o)</code><code>(zoned-date-time arg_1_8593)</code><code>(zoned-date-time arg_1_8594 arg_2_8595)</code><code>(zoned-date-time arg_1_8596 arg_2_8597 arg_3_8598)</code></div><div class="doc"><pre class="plaintext">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)`.</pre></div></div><div class="public anchor" id="var-zoned-date-time.3F"><h3>zoned-date-time?</h3><div class="usage"><code>(zoned-date-time? v__7519__auto__)</code></div><div class="doc"><pre class="plaintext">True if an instance of ZonedDateTime.
</pre></div></div></div></body></html>