forked from dm3/clojure.java-time
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjava-time.html
562 lines (544 loc) · 105 KB
/
java-time.html
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
<!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">1.4.3-SNAPSHOT</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><li class="depth-1 "><a href="CHANGELOG.html"><div class="inner"><span>Changelog</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 branch"><a href="java-time.api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>api</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-*"><div class="inner"><span>*</span></div></a></li><li class="depth-1"><a href="java-time.html#var-.2B"><div class="inner"><span>+</span></div></a></li><li class="depth-1"><a href="java-time.html#var--"><div class="inner"><span>-</span></div></a></li><li class="depth-1"><a href="java-time.html#var-.3C"><div class="inner"><span><</span></div></a></li><li class="depth-1"><a href="java-time.html#var-.3C.3D"><div class="inner"><span><=</span></div></a></li><li class="depth-1"><a href="java-time.html#var-.3D"><div class="inner"><span>=</span></div></a></li><li class="depth-1"><a href="java-time.html#var-.3E"><div class="inner"><span>></span></div></a></li><li class="depth-1"><a href="java-time.html#var-.3E.3D"><div class="inner"><span>>=</span></div></a></li><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-advance-clock.21"><div class="inner"><span>advance-clock!</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-clock.3F"><div class="inner"><span>clock?</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-.3Esql-timestamp"><div class="inner"><span>instant->sql-timestamp</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-mock-clock"><div class="inner"><span>mock-clock</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-not-after.3F"><div class="inner"><span>not-after?</span></div></a></li><li class="depth-1"><a href="java-time.html#var-not-before.3F"><div class="inner"><span>not-before?</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-set-clock.21"><div class="inner"><span>set-clock!</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-when-joda-time-loaded"><div class="inner"><span>when-joda-time-loaded</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-id.3F"><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><h4 class="deprecated">deprecated in 1.1.0</h4><div class="doc"><div class="markdown"><p>This namespace has been deprecated due to <a href="https://github.com/dm3/clojure.java-time/issues/91">#91</a>. Please migrate to <a href="java-time.api.html">java-time.api</a></p>
<p>This namespace will continue to exist and be updated. For maximum JVM compatibility, please migrate to <code>java-time.api</code>, which provides the same interface. <code>java-time</code> and <code>java-time.api</code> and can be freely intermixed within the same library, so you can safely migrate your own code even if your dependencies use the old namespace.</p>
<p>Migration steps:</p>
<ol>
<li>rename all references from <code>java-time</code> to <a href="java-time.api.html">java-time.api</a>. eg., <code>(:require [java-time :as jt])</code> => <code>(:require [java-time.api :as jt])</code></li>
</ol>
</div></div><div class="public anchor" id="var-*"><h3>*</h3><div class="usage"><code>(* o v)</code></div><div class="doc"><div class="markdown"><p>Entity <code>o</code> multiplied by the value <code>v</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L178">view source</a></div></div><div class="public anchor" id="var-.2B"><h3>+</h3><div class="usage"><code>(+ o & os)</code></div><div class="doc"><div class="markdown"><p>Adds all of the <code>os</code> to the time entity <code>o</code>. <code>+</code> is not commutative, the first argument is always the entity which will accumulate the rest of the arguments.</p>
<pre><code>(j/+ (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2016-01-01">
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L185">view source</a></div></div><div class="public anchor" id="var--"><h3>-</h3><div class="usage"><code>(- o & os)</code></div><div class="doc"><div class="markdown"><p>Subtracts all of the <code>os</code> from the time entity <code>o</code></p>
<pre><code>(j/- (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2014-01-01">
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L179">view source</a></div></div><div class="public anchor" id="var-.3C"><h3><</h3><div class="usage"><code>(< x)</code><code>(< x y)</code><code>(< x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the earliest to the latest (same semantics as <code><</code>), otherwise <code>false</code>.</p>
<pre><code>(j/< (local-date 2009) (local-date 2010) (local-date 2011))
=> true
(j/< (interval (instant 10000) (instant 1000000))
(instant 99999999))
=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L134">view source</a></div></div><div class="public anchor" id="var-.3C.3D"><h3><=</h3><div class="usage"><code>(<= x)</code><code>(<= x y)</code><code>(<= x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the earliest to the latest (same semantics as <code><=</code>), otherwise <code>false</code>.</p>
<pre><code>(j/<= (local-date 2009) (local-date 2010) (local-date 2011))
;=> true
(j/<= (interval (instant 10000) (instant 1000000))
(instant 99999999))
;=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L156">view source</a></div></div><div class="public anchor" id="var-.3D"><h3>=</h3><div class="usage"><code>(= x)</code><code>(= x y)</code><code>(= x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns true if all time entities represent the same time, otherwise false.</p>
<p><code>j/=</code> is not commutative, the first argument is always the entity which will accumulate the rest of the arguments.</p>
<p>e.g., (j/= (j/day-of-week :thursday) :thursday) => true</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L193">view source</a></div></div><div class="public anchor" id="var-.3E"><h3>></h3><div class="usage"><code>(> x)</code><code>(> x y)</code><code>(> x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the latest to the earliest (same semantics as <code>></code>), otherwise <code>false</code>.</p>
<pre><code>(j/> (local-date 2011) (local-date 2010) (local-date 2009))
=> true
(j/> (instant 99999999)
(interval (instant 10000) (instant 1000000)))
=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L145">view source</a></div></div><div class="public anchor" id="var-.3E.3D"><h3>>=</h3><div class="usage"><code>(>= x)</code><code>(>= x y)</code><code>(>= x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the latest to the earliest (same semantics as <code>>=</code>), otherwise <code>false</code>.</p>
<pre><code>(j/>= (local-date 2011) (local-date 2010) (local-date 2009))
;=> true
(j/>= (instant 99999999)
(interval (instant 10000) (instant 1000000)))
;=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L167">view source</a></div></div><div class="public anchor" id="var-abs"><h3>abs</h3><div class="usage"><code>(abs a)</code></div><div class="doc"><div class="markdown"><p>Returns the absolute value of a temporal amount:</p>
<p>(abs (negate x)) == (abs x)</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L35">view source</a></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"><div class="markdown"><p>True if this interval abut with the other one</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L701">view source</a></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"><div class="markdown"><p>Adjusts the temporal <code>entity</code> using the provided <code>adjuster</code> with optional <code>args</code>.</p>
<p>The adjuster should either be a keyword which resolves to one of the predefined adjusters (see <a href="java-time.repl.html#var-show-adjusters">java-time.repl/show-adjusters</a>) an instance of <code>TemporalAdjuster</code> or a function which returns another temporal entity when applied to the given one:</p>
<pre><code>(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>
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L555">view source</a></div></div><div class="public anchor" id="var-advance-clock.21"><h3>advance-clock!</h3><div class="usage"><code>(advance-clock! clock amount)</code></div><div class="doc"><div class="markdown"><p>Advances the <code>clock</code> by the given time <code>amount</code>.</p>
<p>This mutates the mock clock.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L468">view source</a></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"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the latest to the earliest (same semantics as <code>></code>), otherwise <code>false</code>.</p>
<pre><code>(after? (local-date 2011) (local-date 2010) (local-date 2009))
=> true
(after? (instant 99999999)
(interval (instant 10000) (instant 1000000)))
=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L64">view source</a></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)</code><code>(am-pm fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>AmPm</code> for the given keyword name (<code>:am</code> or <code>:pm</code>), ordinal or entity. Current AM/PM if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L718">view source</a></div></div><div class="public anchor" id="var-am-pm.3F"><h3>am-pm?</h3><div class="usage"><code>(am-pm? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>org.threeten.extra.AmPm</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L719">view source</a></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"><div class="markdown"><p>Values of property/unit identified by keys/objects <code>ks</code> of the temporal entity <code>o</code>, e.g.</p>
<pre><code>(as (duration 1 :hours) :minutes)
=> 60
(as (local-date 2015 9) :year :month-of-year)
=> [2015 9]
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L91">view source</a></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"><div class="markdown"><p>Converts a time entity to a map of property key -> value as defined by the passed in <code>value-fn</code>. By default the actual value of the unit/field is produced.</p>
<pre><code>(as-map (duration))
=> {:nanos 0, :seconds 0}
(as-map (local-date 2015 1 1))
=> {:year 2015, :month-of-year 1, :day-of-month 1, ...}
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L474">view source</a></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"><div class="markdown"><p>Returns a set of string identifiers for all available ZoneIds.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L345">view source</a></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"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the earliest to the latest (same semantics as <code><</code>), otherwise <code>false</code>.</p>
<pre><code>(before? (local-date 2009) (local-date 2010) (local-date 2011))
=> true
(before? (interval (instant 10000) (instant 1000000))
(instant 99999999))
=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L42">view source</a></div></div><div class="public anchor" id="var-chronology"><h3>chronology</h3><div class="usage"><code>(chronology o)</code></div><div class="doc"><div class="markdown"><p>The <code>Chronology</code> of the entity</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L199">view source</a></div></div><div class="public anchor" id="var-clock.3F"><h3>clock?</h3><div class="usage"><code>(clock? x)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>x</code> is an instance of <code>java.time.Clock</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L428">view source</a></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"><div class="markdown"><p>True if the interval contains the given instant or interval</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L699">view source</a></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"><div class="markdown"><p>Converts an amount from one unit to another. Returns a map of:</p>
<ul>
<li><code>:whole</code> - the whole part of the conversion in the <code>to</code> unit</li>
<li><code>:remainder</code> - the remainder in the <code>from</code> unit</li>
</ul>
<p>Arguments may be keywords or instances of <code>TemporalUnit</code>.</p>
<p>Converts between precise units–nanos up to weeks—treating days as exact multiples of 24 hours. Also converts between imprecise units—months up to millennia. See <code>ChronoUnit</code> and <code>IsoFields</code> for all of the supported units. Does not convert between precise and imprecise units.</p>
<p>Throws <code>ArithmeticException</code> if long overflow occurs during computation.</p>
<pre><code>(convert-amount 10000 :seconds :hours)
=> {:remainder 2800 :whole 2}
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L485">view source</a></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 arg)</code><code>(day-of-month fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>DayOfMonth</code> for the given entity, clock, zone or day of month. Current day of month if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L720">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>org.threeten.extra.DayOfMonth</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L721">view source</a></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)</code><code>(day-of-week fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>DayOfWeek</code> for the given day keyword name (e.g. <code>:monday</code>), ordinal or entity. Current day if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L336">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>True if <code>java.time.DayOfWeek</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L338">view source</a></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 arg)</code><code>(day-of-year fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>DayOfYear</code> for the given entity, clock, zone or day of year. Current day of year if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L721">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>org.threeten.extra.DayOfYear</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L722">view source</a></div></div><div class="public anchor" id="var-days"><h3>days</h3><div class="usage"><code>(days i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Period</code> of <code>i</code> days.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L250">view source</a></div></div><div class="public anchor" id="var-duration"><h3>duration</h3><div class="usage"><code>(duration)</code><code>(duration arg0)</code><code>(duration arg0 arg1)</code></div><div class="doc"><div class="markdown"><p>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.</p>
<p>Given one argument will:</p>
<ul>
<li>interpret as millis if a number</li>
<li>try to parse from the standard format if a string</li>
<li>extract supported units from another <code>TemporalAmount</code></li>
<li>convert from a Joda Period/Duration</li>
</ul>
<p>Given two arguments will:</p>
<ul>
<li>get a duration between two <code>Temporal</code>s</li>
<li>get a duration of a specified unit, e.g. <code>(duration 100 :seconds)</code></li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L210">view source</a></div></div><div class="public anchor" id="var-duration.3F"><h3>duration?</h3><div class="usage"><code>(duration? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.Duration, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L242">view source</a></div></div><div class="public anchor" id="var-end"><h3>end</h3><div class="usage"><code>(end i)</code></div><div class="doc"><div class="markdown"><p>Gets the end instant of the interval</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L698">view source</a></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"><div class="markdown"><p>Returns a <code>TemporalField</code> for the given key <code>k</code> or extracts the field from the given temporal <code>entity</code>.</p>
<p>You can see predefined fields via <a href="java-time.repl.html#var-show-fields">java-time.repl/show-fields</a>.</p>
<p>If you want to make your own custom TemporalFields resolvable, you need to rebind the <code>java-time.properties/*fields*</code> to a custom <code>java_time.properties.FieldGroup</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L263">view source</a></div></div><div class="public anchor" id="var-field.3F"><h3>field?</h3><div class="usage"><code>(field? o)</code></div><div class="doc"><div class="markdown"><p>True if this is a <code>TemporalField</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L262">view source</a></div></div><div class="public anchor" id="var-fields"><h3>fields</h3><div class="usage"><code>(fields o)</code></div><div class="doc"><div class="markdown"><p>Fields present in this temporal entity</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L87">view source</a></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"><div class="markdown"><p>Creates a fixed clock either at the current instant or at the supplied instant/instant + zone.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L422">view source</a></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"><div class="markdown"><p>Formats the given time entity as a string.</p>
<p>Accepts something that can be converted to a <code>DateTimeFormatter</code> or a formatter key, e.g. <code>:iso-offset-time</code>, as a first argument. Given one argument uses the default format.</p>
<pre><code>(format (zoned-date-time))
=> "2015-03-21T09:22:46.677800+01:00[Europe/London]"
(format :iso-date (zoned-date-time))
"2015-03-21+01:00"
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L572">view source</a></div></div><div class="public anchor" id="var-formatter"><h3>formatter</h3><div class="usage"><code>(formatter fmt)</code><code>(formatter fmt arg1)</code></div><div class="doc"><div class="markdown"><p>Constructs a DateTimeFormatter out of a</p>
<ul>
<li>format string - “yyyy/MM/dd”, “HH:mm”, etc.</li>
<li>formatter name - :iso-date, :iso-time, etc.</li>
</ul>
<p>Accepts a map of options as an optional second argument:</p>
<ul>
<li><code>resolver-style</code> - either <code>:strict</code>, <code>:smart</code> or <code>:lenient</code></li>
<li><code>case</code> - either <code>:insensitive</code> or <code>:sensitive</code> (defaults to :sensitive)</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L585">view source</a></div></div><div class="public anchor" id="var-friday.3F"><h3>friday?</h3><div class="usage"><code>(friday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Friday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L531">view source</a></div></div><div class="public anchor" id="var-gap"><h3>gap</h3><div class="usage"><code>(gap i oi)</code></div><div class="doc"><div class="markdown"><p>Gets the gap between this interval and the other one or <code>nil</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L703">view source</a></div></div><div class="public anchor" id="var-hours"><h3>hours</h3><div class="usage"><code>(hours i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> hours.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L248">view source</a></div></div><div class="public anchor" id="var-instant"><h3>instant</h3><div class="usage"><code>(instant)</code><code>(instant arg0)</code><code>(instant arg0 arg1)</code></div><div class="doc"><div class="markdown"><p>Creates an <code>Instant</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current instant</li>
<li>one argument
<ul>
<li>clock</li>
<li>java.util.Date/Calendar</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>millis from epoch</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter (format) and a string</li>
</ul>
</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L272">view source</a></div></div><div class="public anchor" id="var-instant-.3Esql-timestamp"><h3>instant->sql-timestamp</h3><div class="usage"><code>(instant->sql-timestamp instant-or-millis)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>java.sql.Timestamp</code> from the provided <code>instant-or-millis</code> - a millisecond numeric time value or something convertible to an <code>Instant</code>.</p>
<p>Please consider using the JSR-310 Java Time types instead of <code>java.sql.Timestamp</code> if your drivers support them.</p>
<p><code>java.sql.Timestamp</code> is a version of a <code>java.util.Date</code> supposed to be used as a local date-time (no time zone) for the purposes of conversion from/to native JDBC driver TIMESTAMP types.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L622">view source</a></div></div><div class="public anchor" id="var-instant.3F"><h3>instant?</h3><div class="usage"><code>(instant? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.Instant, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L283">view source</a></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"><div class="markdown"><p>Constructs an interval out of a string, start and end instants or a start + duration:</p>
<pre><code>(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>
</code></pre>
<p>Requires the optional <code>threeten-extra</code> dependency.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L704">view source</a></div></div><div class="public anchor" id="var-interval.3F"><h3>interval?</h3><div class="usage"><code>(interval? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>Interval</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L718">view source</a></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"><div class="markdown"><p>Returns a lazy sequence of <code>initial</code> , <code>(apply f initial v vs)</code>, etc.</p>
<p>Useful when you want to produce a sequence of temporal entities, for example:</p>
<pre><code>(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> ...)
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L540">view source</a></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"><div class="markdown"><p>Creates a <code>java.util.Date</code> out of any combination of arguments valid for <a href="java-time.html#var-instant">instant</a> or the Instant itself.</p>
<p>A <code>java.util.Date</code> represents an instant in time. It’s a direct analog of the <code>java.time.Instant</code> type introduced in the JSR-310. Please consider using the <code>java.time.Instant</code> (through <a href="java-time.html#var-instant">instant</a>) directly.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L594">view source</a></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"><div class="markdown"><p>Largest minimum value of this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L105">view source</a></div></div><div class="public anchor" id="var-leap.3F"><h3>leap?</h3><div class="usage"><code>(leap? o)</code></div><div class="doc"><div class="markdown"><p>True if the year of this entity is a leap year.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L200">view source</a></div></div><div class="public anchor" id="var-local-date"><h3>local-date</h3><div class="usage"><code>(local-date)</code><code>(local-date arg0)</code><code>(local-date arg0 arg1)</code><code>(local-date arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>LocalDate</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current local-date</li>
<li>one argument
<ul>
<li>clock</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>year</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter (format) and a string</li>
<li>an instant and a zone id</li>
<li>another temporal entity and an offset (preserves local time)</li>
<li>year and month</li>
</ul>
</li>
<li>three arguments
<ul>
<li>year, month and date</li>
</ul>
</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L284">view source</a></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 arg0)</code><code>(local-date-time arg0 arg1)</code><code>(local-date-time arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>LocalDateTime</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current local date-time</li>
<li>one argument
<ul>
<li>clock</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>year</li>
</ul>
</li>
<li>two arguments
<ul>
<li>local date and local time</li>
<li>an instant and a zone id</li>
<li>formatter (format) and a string</li>
<li>year and month</li>
</ul>
</li>
<li>
<p>three and more arguments - year/month/day/…</p>
</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L299">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.LocalDateTime, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L328">view source</a></div></div><div class="public anchor" id="var-local-date.3F"><h3>local-date?</h3><div class="usage"><code>(local-date? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.LocalDate, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L327">view source</a></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 arg0)</code><code>(local-time arg0 arg1)</code><code>(local-time arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>LocalTime</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current local time</li>
<li>one argument
<ul>
<li>clock</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>hours</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter (format) and a string</li>
<li>an instant and a zone id</li>
<li>hours and minutes</li>
</ul>
</li>
<li>three/four arguments - hour, minute, second, nanos</li>
</ul>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L314">view source</a></div></div><div class="public anchor" id="var-local-time.3F"><h3>local-time?</h3><div class="usage"><code>(local-time? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.LocalTime, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L329">view source</a></div></div><div class="public anchor" id="var-max"><h3>max</h3><div class="usage"><code>(max o & os)</code></div><div class="doc"><div class="markdown"><p>Latest/longest of the given time entities. Entities should be of the same type</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L38">view source</a></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"><div class="markdown"><p>Maximum value of this property, e.g. 29th of February for months</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L104">view source</a></div></div><div class="public anchor" id="var-micros"><h3>micros</h3><div class="usage"><code>(micros micros)</code></div><div class="doc"><div class="markdown"><p>Duration of a specified number of microseconds.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L244">view source</a></div></div><div class="public anchor" id="var-millis"><h3>millis</h3><div class="usage"><code>(millis i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> millis.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L245">view source</a></div></div><div class="public anchor" id="var-min"><h3>min</h3><div class="usage"><code>(min o & os)</code></div><div class="doc"><div class="markdown"><p>Earliest/shortest of the given time entities. Entities should be of the same type</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L40">view source</a></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"><div class="markdown"><p>Minimum value of this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L103">view source</a></div></div><div class="public anchor" id="var-minus"><h3>minus</h3><div class="usage"><code>(minus o & os)</code></div><div class="doc"><div class="markdown"><p>Subtracts all of the <code>os</code> from the time entity <code>o</code></p>
<pre><code>(j/minus (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2014-01-01">
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L127">view source</a></div></div><div class="public anchor" id="var-minutes"><h3>minutes</h3><div class="usage"><code>(minutes i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> minutes.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L247">view source</a></div></div><div class="public anchor" id="var-mock-clock"><h3>mock-clock</h3><div class="usage"><code>(mock-clock)</code><code>(mock-clock instant)</code><code>(mock-clock instant zone)</code></div><div class="doc"><div class="markdown"><p>Returns a mock implementation of the <code>java.time.Clock</code>. The mock supports <code>advance-clock!</code> operation which allows to move the time in the clock, e.g.:</p>
<pre><code>(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)))))
</code></pre>
<p>You can move the clock back via advancing by a negative temporal amount.</p>
<p>Creates a clock at epoch in the default time zone when called without arguments.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L452">view source</a></div></div><div class="public anchor" id="var-monday.3F"><h3>monday?</h3><div class="usage"><code>(monday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Monday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L523">view source</a></div></div><div class="public anchor" id="var-month"><h3>month</h3><div class="usage"><code>(month)</code><code>(month v)</code><code>(month fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>Month</code> for the given month keyword name (e.g. <code>:january</code>), ordinal or entity. Current month if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L333">view source</a></div></div><div class="public anchor" id="var-month-day"><h3>month-day</h3><div class="usage"><code>(month-day)</code><code>(month-day arg)</code><code>(month-day a b)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>MonthDay</code> for the given entity, string, clock, zone or month/day combination. Current month-day if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L339">view source</a></div></div><div class="public anchor" id="var-month-day.3F"><h3>month-day?</h3><div class="usage"><code>(month-day? o)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>java.time.MonthDay</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L341">view source</a></div></div><div class="public anchor" id="var-month.3F"><h3>month?</h3><div class="usage"><code>(month? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>java.time.Month</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L335">view source</a></div></div><div class="public anchor" id="var-months"><h3>months</h3><div class="usage"><code>(months i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Period</code> of <code>i</code> months.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L252">view source</a></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"><div class="markdown"><p>Moves the end instant of the interval by the sum of given periods/durations/numbers of milliseconds.</p>
<pre><code>(move-start-by (interval 0 10000) (millis 1000) (seconds 1))
=> #<Interval ...:00Z/...:12Z>
</code></pre>
<p>Fails if the new end instant falls before the start instant.</p>
<pre><code>(move-end-by (interval 0 10000) (millis -11000))
=> DateTimeException...
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L683">view source</a></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"><div class="markdown"><p>Moves the end of the interval to the given instant (or something convertible to an instant):</p>
<pre><code>(move-end-to (interval 0 10000) (instant 15000))
=> #<Interval ...:00Z/...:15Z>
</code></pre>
<p>Fails if the new end instant falls before the start instant:</p>
<pre><code>(move-end-to (interval 0 10000) (millis -1))
=> DateTimeException...
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L655">view source</a></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"><div class="markdown"><p>Moves the start instant of the interval by the sum of given periods/durations/numbers of milliseconds:</p>
<pre><code>(move-start-by (interval 0 10000) (millis 1000) (seconds 1))
=> #<Interval ...:02Z/...:10Z>
</code></pre>
<p>Fails if the new start instant falls after the end instant.</p>
<pre><code>(move-start-by (interval 0 10000) (millis 11000))
;=> DateTimeException...
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L669">view source</a></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"><div class="markdown"><p>Moves the start instant of the interval to the given instant (or something convertible to an instant):</p>
<pre><code>(move-start-to (interval 0 10000) (instant 5000))
=> #<Interval ...:05Z/...:10Z>
</code></pre>
<p>Fails if the new start instant falls after the end instant:</p>
<pre><code>(move-start-to (interval 0 10000) (millis 15000))
=> DateTimeException...
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L641">view source</a></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"><div class="markdown"><p>Entity <code>o</code> multiplied by the value <code>v</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L133">view source</a></div></div><div class="public anchor" id="var-nanos"><h3>nanos</h3><div class="usage"><code>(nanos i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> nanos.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L243">view source</a></div></div><div class="public anchor" id="var-negate"><h3>negate</h3><div class="usage"><code>(negate a)</code></div><div class="doc"><div class="markdown"><p>Negates a temporal amount:</p>
<p>(negate (negate x)) == x</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L32">view source</a></div></div><div class="public anchor" id="var-negative.3F"><h3>negative?</h3><div class="usage"><code>(negative? a)</code></div><div class="doc"><div class="markdown"><p>True if the amount is negative</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L31">view source</a></div></div><div class="public anchor" id="var-not-after.3F"><h3>not-after?</h3><div class="usage"><code>(not-after? x)</code><code>(not-after? x y)</code><code>(not-after? x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the earliest to the latest (same semantics as <code><=</code>), otherwise <code>false</code>.</p>
<pre><code>(not-after? (local-date 2009) (local-date 2010) (local-date 2011))
;=> true
(not-after? (interval (instant 10000) (instant 1000000))
(instant 99999999))
;=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L53">view source</a></div></div><div class="public anchor" id="var-not-before.3F"><h3>not-before?</h3><div class="usage"><code>(not-before? x)</code><code>(not-before? x y)</code><code>(not-before? x y & more)</code></div><div class="doc"><div class="markdown"><p>Returns <code>true</code> if time entities are ordered from the latest to the earliest (same semantics as <code>>=</code>), otherwise <code>false</code>.</p>
<pre><code>(not-before? (local-date 2011) (local-date 2010) (local-date 2009))
;=> true
(not-before? (instant 99999999)
(interval (instant 10000) (instant 1000000)))
;=> true
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L75">view source</a></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"><div class="markdown"><p>Creates a clock offset from the current/provided clock by a given <code>duration</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L424">view source</a></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 arg0)</code><code>(offset-date-time arg0 arg1)</code><code>(offset-date-time arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates an <code>OffsetDateTime</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current date-time with the default offset</li>
<li>one argument
<ul>
<li>clock</li>
<li>zone offset</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>year</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter (format) and a string</li>
<li>local date-time and an offset</li>
<li>another temporal entity and an offset (preserves local time)</li>
<li>year and month</li>
</ul>
</li>
<li>three arguments
<ul>
<li>local date, local time and an offset</li>
<li>year, month and date</li>
</ul>
</li>
<li>four up to seven arguments - position date-time constructors</li>
<li>eight arguments - time fields up to nanoseconds and a zone offset</li>
</ul>
<p>If zone offset is not specified, default will be used. You can check the default offset by invoking <code>(zone-offset)</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L357">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.OffsetDateTime, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L431">view source</a></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 arg0)</code><code>(offset-time arg0 arg1)</code></div><div class="doc"><div class="markdown"><p>Creates an <code>OffsetTime</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current time with the default offset</li>
<li>one argument
<ul>
<li>clock</li>
<li>zone id</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>hour</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter (format) and a string</li>
<li>local time and an offset</li>
<li>instant and an offset</li>
<li>hour and minutes</li>
</ul>
</li>
<li>three arguments - hours, minutes, seconds</li>
<li>four arguments - hours, minutes, seconds, nanos</li>
<li>five arguments - last is the offset</li>
</ul>
<p>If zone offset is not specified, default will be used. You can check the default offset by invoking <code>(zone-offset)</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L379">view source</a></div></div><div class="public anchor" id="var-offset-time.3F"><h3>offset-time?</h3><div class="usage"><code>(offset-time? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.OffsetTime, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L432">view source</a></div></div><div class="public anchor" id="var-overlap"><h3>overlap</h3><div class="usage"><code>(overlap i oi)</code></div><div class="doc"><div class="markdown"><p>Gets the overlap between this interval and the other one or <code>nil</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L702">view source</a></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"><div class="markdown"><p>True if this interval overlaps the other one</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L700">view source</a></div></div><div class="public anchor" id="var-period"><h3>period</h3><div class="usage"><code>(period)</code><code>(period arg0)</code><code>(period arg0 arg1)</code><code>(period arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a period - a temporal entity consisting of years, months and days.</p>
<p>Given one argument will</p>
<ul>
<li>interpret as years if a number</li>
<li>try to parse from the standard format if a string</li>
<li>extract supported units from another <code>TemporalAmount</code></li>
<li>convert from a Joda Period</li>
</ul>
<p>Given two arguments will</p>
<ul>
<li>get a period of a specified unit, e.g. <code>(period 10 :months)</code></li>
<li>get a period between two temporals by converting them to local dates</li>
<li>get a period of a specified number of years and months</li>
</ul>
<p>Given three arguments will create a year/month/day period.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L225">view source</a></div></div><div class="public anchor" id="var-period.3F"><h3>period?</h3><div class="usage"><code>(period? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.Period, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L241">view source</a></div></div><div class="public anchor" id="var-plus"><h3>plus</h3><div class="usage"><code>(plus o & os)</code></div><div class="doc"><div class="markdown"><p>Adds all of the <code>os</code> to the time entity <code>o</code>. <code>plus</code> is not commutative, the first argument is always the entity which will accumulate the rest of the arguments.</p>
<pre><code>(j/plus (j/local-date 2015) (j/years 1))
=> <java.time.LocalDate "2016-01-01">
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L119">view source</a></div></div><div class="public anchor" id="var-properties"><h3>properties</h3><div class="usage"><code>(properties o)</code></div><div class="doc"><div class="markdown"><p>Map of properties present in this temporal entity</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L89">view source</a></div></div><div class="public anchor" id="var-property"><h3>property</h3><div class="usage"><code>(property o k)</code></div><div class="doc"><div class="markdown"><p>Property of this temporal entity under key <code>k</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L90">view source</a></div></div><div class="public anchor" id="var-quarter"><h3>quarter</h3><div class="usage"><code>(quarter)</code><code>(quarter v)</code><code>(quarter fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>Quarter</code> for the given quarter keyword name (e.g. <code>:q1</code>), ordinal or entity. Current quarter if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L719">view source</a></div></div><div class="public anchor" id="var-quarter.3F"><h3>quarter?</h3><div class="usage"><code>(quarter? o)</code></div><div class="doc"><div class="markdown"><p>True if <code>org.threeten.extra.Quarter</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L720">view source</a></div></div><div class="public anchor" id="var-range"><h3>range</h3><div class="usage"><code>(range p)</code></div><div class="doc"><div class="markdown"><p>Range of values for this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L102">view source</a></div></div><div class="public anchor" id="var-saturday.3F"><h3>saturday?</h3><div class="usage"><code>(saturday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Saturday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L533">view source</a></div></div><div class="public anchor" id="var-seconds"><h3>seconds</h3><div class="usage"><code>(seconds i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> seconds.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L246">view source</a></div></div><div class="public anchor" id="var-set-clock.21"><h3>set-clock!</h3><div class="usage"><code>(set-clock! clock time)</code></div><div class="doc"><div class="markdown"><p>Sets the <code>clock</code> to the given <code>time</code>.</p>
<p>This mutates the mock clock.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L471">view source</a></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"><div class="markdown"><p>Smallest maximum value of this property, e.g. 28th of February for months</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L106">view source</a></div></div><div class="public anchor" id="var-sql-date"><h3>sql-date</h3><div class="usage"><code>(sql-date)</code><code>(sql-date arg0)</code><code>(sql-date arg0 arg1)</code><code>(sql-date arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>java.sql.Date</code> out of any combination of arguments valid for <a href="java-time.html#var-local-date">local-date</a> or the <code>LocalDate</code> itself.</p>
<p>Please consider using the JSR-310 Java Time types instead of <code>java.sql.Date</code> if your drivers support them.</p>
<p>Even though <code>java.sql.Date</code> extends a <code>java.util.Date</code>, it’s supposed to be used as a local date (no time component or time zone) for the purposes of conversion from/to native JDBC driver DATE types.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L600">view source</a></div></div><div class="public anchor" id="var-sql-time"><h3>sql-time</h3><div class="usage"><code>(sql-time)</code><code>(sql-time arg0)</code><code>(sql-time arg0 arg1)</code><code>(sql-time arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>java.sql.Time</code> out of any combination of arguments valid for <a href="java-time.html#var-local-time">local-time</a> (except the nanos constructor) or the <code>LocalTime</code> itself.</p>
<p>Please consider using the JSR-310 Java Time types instead of <code>java.sql.Time</code> if your drivers support them.</p>
<p>Even though <code>java.sql.Time</code> extends a <code>java.util.Date</code>, it’s supposed to be used as a local time (no date component or time zone) for the purposes of conversion from/to native JDBC driver TIME types.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L631">view source</a></div></div><div class="public anchor" id="var-sql-timestamp"><h3>sql-timestamp</h3><div class="usage"><code>(sql-timestamp)</code><code>(sql-timestamp arg0)</code><code>(sql-timestamp arg0 arg1)</code><code>(sql-timestamp arg0 arg1 arg2)</code><code>(sql-timestamp arg0 arg1 arg2 arg3)</code><code>(sql-timestamp arg0 arg1 arg2 arg3 arg4)</code><code>(sql-timestamp arg0 arg1 arg2 arg3 arg4 arg5)</code><code>(sql-timestamp arg0 arg1 arg2 arg3 arg4 arg5 arg6)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>java.sql.Timestamp</code> in the local time zone out of any combination of arguments valid for <a href="java-time.html#var-local-date-time">local-date-time</a> or the <code>LocalDateTime</code> itself.</p>
<p>Does not support <code>Timestamp</code> construction from an <code>Instant</code> or a long millis value—please use <a href="java-time.html#var-instant-.3Esql-timestamp">instant->sql-timestamp</a> for this purpose.</p>
<p>Please consider using the JSR-310 Java Time types instead of <code>java.sql.Timestamp</code> if your drivers support them.</p>
<p><code>java.sql.Timestamp</code> is a version of a <code>java.util.Date</code> supposed to be used as a local date-time (no time zone) for the purposes of conversion from/to native JDBC driver TIMESTAMP types.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L609">view source</a></div></div><div class="public anchor" id="var-standard-days"><h3>standard-days</h3><div class="usage"><code>(standard-days i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Duration</code> of <code>i</code> days.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L249">view source</a></div></div><div class="public anchor" id="var-start"><h3>start</h3><div class="usage"><code>(start i)</code></div><div class="doc"><div class="markdown"><p>Gets the start instant of the interval</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L697">view source</a></div></div><div class="public anchor" id="var-sunday.3F"><h3>sunday?</h3><div class="usage"><code>(sunday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Sunday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L535">view source</a></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"><div class="markdown"><p>True if the <code>o</code> entity supports the <code>p</code> property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L86">view source</a></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"><div class="markdown"><p>Creates a system clock. In the default time zone if called without arguments, otherwise accepts a Zone Id.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L420">view source</a></div></div><div class="public anchor" id="var-thursday.3F"><h3>thursday?</h3><div class="usage"><code>(thursday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Thursday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L529">view source</a></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"><div class="markdown"><p>Creates a clock wrapping system/provided clock that only ticks as per specified duration.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L426">view source</a></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"><div class="markdown"><p>Time between temporal entities <code>o</code> and <code>e</code> in unit <code>u</code>.</p>
<pre><code>(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
</code></pre>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L109">view source</a></div></div><div class="public anchor" id="var-to-java-date"><h3>to-java-date</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(to-java-date o)</code></div><div class="doc"><div class="markdown"><p>Converts a date entity to a <code>java.util.Date</code>.</p>
<p><em>Deprecated</em>: This function only has a single arity and works for entities directly convertible to <code>java.time.Instant</code>. Please consider using <a href="java-time.html#var-java-date">java-date</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L503">view source</a></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"><div class="markdown"><p>Converts a date entity to a <code>long</code> representing the number of milliseconds from epoch.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L521">view source</a></div></div><div class="public anchor" id="var-to-sql-date"><h3>to-sql-date</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(to-sql-date o)</code></div><div class="doc"><div class="markdown"><p>Converts a local date entity to a <code>java.sql.Date</code>.</p>
<p><em>Deprecated</em>: This function only has a single arity and works for entities directly convertible to <code>java.time.LocalDate</code>. Please consider using <a href="java-time.html#var-sql-date">sql-date</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L509">view source</a></div></div><div class="public anchor" id="var-to-sql-timestamp"><h3>to-sql-timestamp</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(to-sql-timestamp o)</code></div><div class="doc"><div class="markdown"><p>Converts a date entity to a <code>java.sql.Timestamp</code>.</p>
<p><em>Deprecated</em>: This function only has a single arity and works for entities directly convertible to <code>java.time.Instant</code>. Please consider using <a href="java-time.html#var-sql-timestamp">sql-timestamp</a> instead.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L515">view source</a></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"><div class="markdown"><p>Truncates this entity to the specified time unit. Only works for units that divide into the length of standard day without remainder (up to <code>:days</code>).</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L107">view source</a></div></div><div class="public anchor" id="var-tuesday.3F"><h3>tuesday?</h3><div class="usage"><code>(tuesday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Tuesday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L525">view source</a></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"><div class="markdown"><p>Returns a <code>TemporalUnit</code> for the given key <code>k</code> or extracts the field from the given temporal <code>entity</code>.</p>
<p>You can see predefined units via <a href="java-time.repl.html#var-show-units">java-time.repl/show-units</a>.</p>
<p>If you want to make your own custom TemporalUnits resolvable, you need to rebind the <code>java-time.properties/*units*</code> to a custom <code>java_time.properties.UnitGroup</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L255">view source</a></div></div><div class="public anchor" id="var-unit.3F"><h3>unit?</h3><div class="usage"><code>(unit? o)</code></div><div class="doc"><div class="markdown"><p>True if this is a <code>TemporalUnit</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L254">view source</a></div></div><div class="public anchor" id="var-units"><h3>units</h3><div class="usage"><code>(units o)</code></div><div class="doc"><div class="markdown"><p>Units present in this temporal entity.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L88">view source</a></div></div><div class="public anchor" id="var-value"><h3>value</h3><div class="usage"><code>(value p)</code></div><div class="doc"><div class="markdown"><p>Value of the property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L101">view source</a></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 arg0)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>ValueRange</code> given the <code>min</code> and <code>max</code> amounts or a map of <code>:min-smallest</code>, <code>:max-smallest</code>, <code>:min-largest</code> and <code>:max-largest</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L270">view source</a></div></div><div class="public anchor" id="var-wednesday.3F"><h3>wednesday?</h3><div class="usage"><code>(wednesday? i)</code></div><div class="doc"><div class="markdown"><p>Returns true if the given time entity with the <code>day-of-week</code> property falls on a Wednesday, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L527">view source</a></div></div><div class="public anchor" id="var-weekday.3F"><h3>weekday?</h3><div class="usage"><code>(weekday? dt)</code></div><div class="doc"><div class="markdown"><p>Complement of <a href="java-time.html#var-weekend.3F">weekend?</a>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L539">view source</a></div></div><div class="public anchor" id="var-weekend.3F"><h3>weekend?</h3><div class="usage"><code>(weekend? dt)</code></div><div class="doc"><div class="markdown"><p>Returns true if argument is <a href="java-time.html#var-saturday.3F">saturday?</a> or <a href="java-time.html#var-sunday.3F">sunday?</a>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L537">view source</a></div></div><div class="public anchor" id="var-weeks"><h3>weeks</h3><div class="usage"><code>(weeks i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Period</code> of <code>i</code> weeks.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L251">view source</a></div></div><div class="public anchor" id="var-when-joda-time-loaded"><h3>when-joda-time-loaded</h3><h4 class="type">macro</h4><div class="usage"><code>(when-joda-time-loaded & body)</code></div><div class="doc"><div class="markdown"><p>Execute the <code>body</code> when Joda-Time classes are found on the classpath.</p>
<p>Take care - when AOT-compiling code using this macro, the Joda-Time classes must be on the classpath at compile time!</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L23">view source</a></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"><div class="markdown"><p>Executes the given <code>forms</code> in the scope of the provided <code>clock</code>.</p>
<p>All the temporal entities that get created without parameters will inherit their values from the clock:</p>
<p>(with-clock (system-clock “Europe/London”) (zone-id)) => #<java.time.ZoneRegion Europe/London></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L15">view source</a></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"><div class="markdown"><p>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.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L27">view source</a></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"><div class="markdown"><p>Underlying temporal entity with the value set to the largest minimum available for this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L206">view source</a></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"><div class="markdown"><p>Underlying temporal entity with the value set to the maximum available for this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L204">view source</a></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"><div class="markdown"><p>Underlying temporal entity with the value set to the minimum available for this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L202">view source</a></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"><div class="markdown"><p>Sets the offset to the specified value ensuring that the local time stays the same.</p>
<p>(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></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L439">view source</a></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"><div class="markdown"><p>Sets the offset to the specified value ensuring that the result has the same instant, e.g.:</p>
<p>(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></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L446">view source</a></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"><div class="markdown"><p>Underlying temporal entity with the value set to the smallest maximum available for this property</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L208">view source</a></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"><div class="markdown"><p>Underlying temporal entity with the value of this property set to <code>v</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L201">view source</a></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"><div class="markdown"><p>Returns this temporal entity with the specified <code>ZoneId</code></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L118">view source</a></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"><div class="markdown"><p>Sets the zone to the specified value ensuring that the result has the same instant, e.g.:</p>
<p>(zoned-date-time 2015) => #<java.time.ZonedDateTime 2015-01-01T00:00+00:00<a href="Europe/London">Europe/London</a>> (with-zone-same-instant *1 “America/New_York”) => #<java.time.ZonedDateTime 2014-12-31T18:00-05:00<a href="America/New_York">America/New_York</a>></p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L433">view source</a></div></div><div class="public anchor" id="var-year"><h3>year</h3><div class="usage"><code>(year)</code><code>(year arg)</code><code>(year fmt arg)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>Year</code> for the given entity, string, clock, zone or number. Current year if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L330">view source</a></div></div><div class="public anchor" id="var-year-month"><h3>year-month</h3><div class="usage"><code>(year-month)</code><code>(year-month arg)</code><code>(year-month a b)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>YearMonth</code> for the given entity, string, clock, zone or month/day combination. Current year-month if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L342">view source</a></div></div><div class="public anchor" id="var-year-month.3F"><h3>year-month?</h3><div class="usage"><code>(year-month? o)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>java.time.YearMonth</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L344">view source</a></div></div><div class="public anchor" id="var-year-quarter"><h3>year-quarter</h3><div class="usage"><code>(year-quarter)</code><code>(year-quarter arg)</code><code>(year-quarter a b)</code></div><div class="doc"><div class="markdown"><p>Returns the <code>YearQuarter</code> for the given entity, clock, zone or year with quarter. Current year quarter if no arguments given.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L722">view source</a></div></div><div class="public anchor" id="var-year-quarter.3F"><h3>year-quarter?</h3><div class="usage"><code>(year-quarter? o)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>org.threeten.extra.YearQuarter</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L723">view source</a></div></div><div class="public anchor" id="var-year.3F"><h3>year?</h3><div class="usage"><code>(year? o)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>o</code> is <code>java.time.Year</code>, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L332">view source</a></div></div><div class="public anchor" id="var-years"><h3>years</h3><div class="usage"><code>(years i)</code></div><div class="doc"><div class="markdown"><p>Returns a <code>Period</code> of <code>i</code> years.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L253">view source</a></div></div><div class="public anchor" id="var-zero.3F"><h3>zero?</h3><div class="usage"><code>(zero? a)</code></div><div class="doc"><div class="markdown"><p>True if the amount is zero</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L30">view source</a></div></div><div class="public anchor" id="var-zone-id"><h3>zone-id</h3><div class="usage"><code>(zone-id)</code><code>(zone-id arg0)</code><code>(zone-id arg0 arg1)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>ZoneId</code> from a string identifier, <code>java.util.TimeZone</code> or extracts from another temporal entity.</p>
<p>Returns default system zone id if no arguments provided.</p>
<p>Given two arguments will use the second as the offset.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L346">view source</a></div></div><div class="public anchor" id="var-zone-id.3F"><h3>zone-id?</h3><div class="usage"><code>(zone-id? v)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.ZoneId, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L429">view source</a></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"><div class="markdown"><p>Creates a <code>ZoneOffset</code> from a string identifier (e.g. “+01”), a number of hours/hours and minutes/hours, minutes and seconds or extracts from another temporal entity.</p>
<p>Returns default system zone offset if no arguments provided.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L352">view source</a></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 arg0)</code><code>(zoned-date-time arg0 arg1)</code><code>(zoned-date-time arg0 arg1 arg2)</code></div><div class="doc"><div class="markdown"><p>Creates a <code>ZonedDateTime</code>. The following arguments are supported:</p>
<ul>
<li>no arguments - current date-time in the default zone</li>
<li>one argument
<ul>
<li>clock</li>
<li>zone id</li>
<li>another temporal entity</li>
<li>string representation</li>
<li>year</li>
</ul>
</li>
<li>two arguments
<ul>
<li>formatter and a string</li>
<li>local date-time and a zone id</li>
<li>year and month</li>
</ul>
</li>
<li>three arguments
<ul>
<li>local date, local time and a zone id</li>
<li>year, month and day</li>
</ul>
</li>
<li>four to seven arguments - date-time fields</li>
<li>eight arguments - last is the zone id</li>
</ul>
<p>If zone id is not specified, default zone id will be used. You can check the default zone by invoking <code>(zone-id)</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L399">view source</a></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)</code></div><div class="doc"><div class="markdown"><p>Returns true if <code>v</code> is an instance of java.time.ZonedDateTime, otherwise false.</p>
</div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/710292539917f477737970e8cc706e1f0a3c3687/src/java_time.clj#L430">view source</a></div></div></div></body></html>