-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfndate.html
executable file
·339 lines (312 loc) · 26.6 KB
/
fndate.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia Site Renderer 1.3 at May 19, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>op4j: bending the Java spoon -
Functions: FnDate</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20120519" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="./" id="bannerLeft">
<img src="images/op4j_logo.png" alt="op4j: bending the Java spoon" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 19 May 2012</span>
| <span id="projectVersion">Version: 1.2</span>
</div>
<div class="xright"> <a href="index.html" title="Main">Main</a>
|
<a href="download.html" title="Download">Download</a>
|
<a href="https://www.bendingthejavaspoon.com" class="externalLink" title="Example Recipes Blog">Example Recipes Blog</a>
|
<a href="https://github.com/op4j/op4j.github.com/issues" class="externalLink" title="Issue Tracking">Issue Tracking</a>
|
<a href="apidocs/index.html" title="Javadoc">Javadoc</a>
|
<a href="https://github.com/op4j" class="externalLink" title="Github Project Page">Github Project Page</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>The op4j Project</h5>
<ul>
<li class="none">
<a href="index.html" title="· Main">· Main</a>
</li>
<li class="none">
<a href="download.html" title="· Download">· Download</a>
</li>
<li class="none">
<a href="maveninfo.html" title="· Maven Info">· Maven Info</a>
</li>
<li class="none">
<a href="dependencies.html" title="· Dependencies">· Dependencies</a>
</li>
<li class="none">
<a href="https://github.com/op4j" class="externalLink" title="· Github Repository">· Github Repository</a>
</li>
<li class="none">
<a href="https://www.bendingthejavaspoon.com" class="externalLink" title="· Example Recipes">· Example Recipes</a>
</li>
<li class="none">
<a href="https://github.com/op4j/op4j.github.com/issues" class="externalLink" title="· Issue Tracking">· Issue Tracking</a>
</li>
<li class="expanded">
<a href="#" title="· Documentation">· Documentation</a>
<ul>
<li class="none">
<a href="basics.html" title="· The Basics">· The Basics</a>
</li>
<li class="expanded">
<a href="#" title="· Working with...">· Working with...</a>
<ul>
<li class="none">
<a href="arrays.html" title="· Arrays">· Arrays</a>
</li>
<li class="none">
<a href="lists.html" title="· Lists">· Lists</a>
</li>
<li class="none">
<a href="maps.html" title="· Maps">· Maps</a>
</li>
<li class="none">
<a href="sets.html" title="· Sets">· Sets</a>
</li>
<li class="none">
<a href="generic.html" title="· Any object (generic)">· Any object (generic)</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="#" title="· Functions">· Functions</a>
<ul>
<li class="none">
<a href="functions.html" title="· About Functions">· About Functions</a>
</li>
<li class="none">
<a href="call.html" title="· Call">· Call</a>
</li>
<li class="none">
<a href="get.html" title="· Get">· Get</a>
</li>
<li class="none">
<a href="fnfunc.html" title="· FnFunc">· FnFunc</a>
</li>
<li class="none">
<a href="fnboolean.html" title="· FnBoolean">· FnBoolean</a>
</li>
<li class="none">
<a href="fncalendar.html" title="· FnCalendar">· FnCalendar</a>
</li>
<li class="none">
<strong>· FnDate</strong>
</li>
<li class="none">
<a href="fnobject.html" title="· FnObject">· FnObject</a>
</li>
<li class="none">
<a href="fnstring.html" title="· FnString">· FnString</a>
</li>
<li class="expanded">
<a href="#" title="· Numbers">· Numbers</a>
<ul>
<li class="none">
<a href="fnnumber.html" title="· FnNumber">· FnNumber</a>
</li>
<li class="none">
<a href="fnbigdecimal.html" title="· FnBigDecimal">· FnBigDecimal</a>
</li>
<li class="none">
<a href="fnbiginteger.html" title="· FnBigInteger">· FnBigInteger</a>
</li>
<li class="none">
<a href="fninteger.html" title="· FnInteger">· FnInteger</a>
</li>
<li class="none">
<a href="fnlong.html" title="· FnLong">· FnLong</a>
</li>
<li class="none">
<a href="fnfloat.html" title="· FnFloat">· FnFloat</a>
</li>
<li class="none">
<a href="fndouble.html" title="· FnDouble">· FnDouble</a>
</li>
<li class="none">
<a href="fndouble.html" title="· FnShort">· FnShort</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="#" title="· Structures">· Structures</a>
<ul>
<li class="none">
<a href="fnarray.html" title="· FnArray">· FnArray</a>
</li>
<li class="none">
<a href="fnlist.html" title="· FnList">· FnList</a>
</li>
<li class="none">
<a href="fnmap.html" title="· FnMap">· FnMap</a>
</li>
<li class="none">
<a href="fnset.html" title="· FnSet">· FnSet</a>
</li>
<li class="none">
<a href="fntuple.html" title="· FnTuple">· FnTuple</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="none">
<a href="apidocs/op4j/index.html" title="· Javadoc">· Javadoc</a>
</li>
<li class="none">
<a href="faq.html" title="· FAQ">· FAQ</a>
</li>
</ul>
</li>
<li class="none">
<a href="license.html" title="· License">· License</a>
</li>
<li class="none">
<a href="team.html" title="· Team">· Team</a>
</li>
</ul>
<ul>
<li class="collapsed">
<a href="ognl-about.html" title="· op4j-ognl">· op4j-ognl</a>
</li>
<li class="collapsed">
<a href="jodatime-about.html" title="· op4j-jodatime">· op4j-jodatime</a>
</li>
</ul>
<a href="https://maven.apache.org" title="Built with Maven 2" class="poweredBy">
<img class="poweredBy" alt="Built with Maven 2" src="https://maven.apache.org/images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>Functions: FnDate<a name="Functions:_FnDate"></a></h2>
<div class="section"><h3>1. Overview<a name="a1._Overview"></a></h3>
<p>
<b><a class="externalLink" href="https://www.op4j.org/apidocs/org/op4j/functions/FnDate.html">FnDate</a></b> is a <i>function hub class</i>
containing a lot of static methods to work with Date objects. Those static methods return functions that take
a <b>Date</b> object either as its input or output (depending on the function). It includes
conversions to String, to Date and adding days to a Date among others.
</p>
</div>
<div class="section"><h3>2. Functions<a name="a2._Functions"></a></h3>
<table class="bodyTable" border="0">
<thead><tr class="a"><th>Function name</th><th>Type</th><th width="240px">Params</th><th>Description</th></tr></thead>
<tbody>
<tr class="b"><td><b>add</b></td><td>Function<Date,Date></td><td>int calendarField<br />int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one of its fields. </p> <p> Fields are specified by means of <tt>java.util.Calendar</tt> constants, like <tt>FnDate.add(Calendar.DAY_OF_MONTH, 1)</tt>. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>addDays</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "day" property (<tt>java.util.Calendar.DATE</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>addHours</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "hour" property (<tt>java.util.Calendar.HOUR</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>addMilliseconds</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "millisecond" property (<tt>java.util.Calendar.MILLISECOND</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>addMinutes</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "minutes" property (<tt>java.util.Calendar.MINUTES</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>addMonths</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "month" property (<tt>java.util.Calendar.MONTH</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>addWeeks</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "week" property (<tt>java.util.Calendar.WEEK</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>addYears</b></td><td>Function<Date,Date></td><td>int amount</td><td><p> Modifies a Date by adding a positive or negative amount to one the "year" property (<tt>java.util.Calendar.YEAR</tt>). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>after</b></td><td>Function<Date,Boolean></td><td>Date date</td><td><p> Determines whether the target Date represents a moment in time after the Date specified as a parameter. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>before</b></td><td>Function<Date,Boolean></td><td>Date date</td><td><p> Determines whether the target Date represents a moment in time before the Date specified as a parameter. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>eq</b></td><td>Function<Object,Boolean></td><td>Date object</td><td><p> Determines whether the target object and the specified object are equal by calling the <tt>equals</tt> method on the target object. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>fieldIntegerArrayToDate</b></td><td>Function<Integer[], Date></td><td></td><td><p> Converts an Integer[] containing the components of a date to a <tt>java.util.Date</tt> object. </p> <p> The target array can contain the following combinations of elements, in the specified order: </p> <ul> <li>year, month, day</li> <li>year, month, day, hour, minute</li> <li>year, month, day, hour, minute, second</li> <li>year, month, day, hour, minute, second, millisecond</li> </ul></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>fieldIntegerListToDate</b></td><td>Function<List<Integer>, Date></td><td></td><td><p> Converts a List<Integer> containing the components of a date to a <tt>java.util.Date</tt> object. </p> <p> The target list can contain the following combinations of elements, in the specified order: </p> <ul> <li>year, month, day</li> <li>year, month, day, hour, minute</li> <li>year, month, day, hour, minute, second</li> <li>year, month, day, hour, minute, second, millisecond</li> </ul></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>fieldStringArrayToDate</b></td><td>Function<String[], Date></td><td></td><td><p> Converts a String[] containing the components of a date to a <tt>java.util.Date</tt> object. </p> <p> The target array can contain the following combinations of elements, all of them in numeric format, in the specified order: </p> <ul> <li>year, month, day</li> <li>year, month, day, hour, minute</li> <li>year, month, day, hour, minute, second</li> <li>year, month, day, hour, minute, second, millisecond</li> </ul></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>fieldStringListToDate</b></td><td>Function<List<String>, Date></td><td></td><td><p> Converts a List<String> containing the components of a date to a <tt>java.util.Date</tt> object. </p> <p> The target list can contain the following combinations of elements, all of them in numeric format, in the specified order: </p> <ul> <li>year, month, day</li> <li>year, month, day, hour, minute</li> <li>year, month, day, hour, minute, second</li> <li>year, month, day, hour, minute, second, millisecond</li> </ul></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>isNotNull</b></td><td>Function<Object,Boolean></td><td></td><td><p> Determines whether the target object is null or not. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>isNull</b></td><td>Function<Object,Boolean></td><td></td><td><p> Determines whether the target object is null or not. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>notEq</b></td><td>Function<Object,Boolean></td><td>Date object</td><td><p> Determines whether the target object and the specified object are NOT equal by calling the <tt>equals</tt> method on the target object. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>round</b></td><td>Function<Date,Date></td><td>int calendarField</td><td><p> Rounds the target Date, setting the specified field as the most significant field. </p> <p> Based on <tt>org.apache.commons.lang.time.DateUtils.round()</tt>. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>set</b></td><td>Function<Date,Date></td><td>int calendarField<br />int value</td><td><p> Modifies a Date by setting one of its to the specified value. </p> <p> Fields are specified by means of <tt>java.util.Calendar</tt> constants, like <tt>FnDate.set(Calendar.DAY_OF_MONTH, 12)</tt>. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>setDay</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "day" property (<tt>java.util.Calendar.DATE</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>setHour</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "hour" property (<tt>java.util.Calendar.HOUR</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>setMillisecond</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "millisecond" property (<tt>java.util.Calendar.MILLISECOND</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>setMinute</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "minute" property (<tt>java.util.Calendar.MINUTE</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>setMonth</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "month" property (<tt>java.util.Calendar.MONTH</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>setWeek</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "week" property (<tt>java.util.Calendar.WEEK_OF_YEAR</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="b"><td><b>setYear</b></td><td>Function<Date,Date></td><td>int value</td><td><p> Modifies a Date by setting the "year" property (<tt>java.util.Calendar.YEAR</tt>) to the specified value. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>timeInMillisToDate</b></td><td>Function<Long,Date></td><td></td><td><p> Converts the target Long (representing a time in milliseconds) into a Date. </p></td></tr>
<tr class="b"><td><b>timeInMillisToDate</b></td><td>Function<Long,Date></td><td>int truncateField</td><td><p> Converts the target Long (representing a time in milliseconds) into a Date, truncating by the specified field (<tt>java.util.Calendar</tt> constant field). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>timestampToDate</b></td><td>Function<Timestamp,Date></td><td></td><td><p> Converts the target <tt>java.sql.Timestamp</tt> into a Date. </p></td></tr>
<tr class="b"><td><b>timestampToDate</b></td><td>Function<Timestamp,Date></td><td>int truncateField</td><td><p> Converts the target <tt>java.sql.Timestamp</tt> into a Date, truncating by the specified field (<tt>java.util.Calendar</tt> constant field). </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>toCalendar</b></td><td>Function<Date,Calendar></td><td></td><td></td></tr>
<tr class="b"><td><b>toCalendar</b></td><td>Function<Date,Calendar></td><td>int truncateField</td><td></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>toStr</b></td><td>Function<Date,String></td><td>String pattern</td><td><p> Converts the target Date into a String using the specified <tt>pattern</tt>. The pattern has to be written in the <tt>java.text.SimpleDateFormat</tt> format. </p> <p> As no locale is specified, if pattern includes locale-dependent texts like month names (<tt>MMM</tt>) or week days (<tt>EEE</tt>), the default locale will be used for resolving these components. </p></td></tr>
<tr class="b"><td><b>toStr</b></td><td>Function<Date,String></td><td>String pattern<br />Locale locale</td><td><p> Converts the target Date into a String using the specified <tt>pattern</tt>. The pattern has to be written in the <tt>java.text.SimpleDateFormat</tt> format, and the specified locale will be used for text-based pattern components (like month names or week days). </p></td></tr>
<tr class="a"><td><b>toStr</b></td><td>Function<Date,String></td><td>String pattern<br />String locale</td><td><p> Converts the target Date into a String using the specified <tt>pattern</tt>. The pattern has to be written in the <tt>java.text.SimpleDateFormat</tt> format, and the specified locale will be used for text-based pattern components (like month names or week days). </p></td></tr>
<tr class="b"><td><b>toStr</b></td><td>Function<Date,String></td><td>DateStyle dateStyle<br />TimeStyle timeStyle</td><td><p> Converts the target Date into a String using the specified date ( DateStyle) and time ( TimeStyle) styles. </p></td></tr>
<tr class="a"><td><b>toStr</b></td><td>Function<Date,String></td><td>DateStyle dateStyle<br />TimeStyle timeStyle<br />Locale locale</td><td><p> Converts the target Date into a String using the specified date ( DateStyle) and time ( TimeStyle) styles, and resolving text-based components like month names using the specified locale. </p></td></tr>
<tr class="b"><td><b>toStr</b></td><td>Function<Date,String></td><td>DateStyle dateStyle<br />TimeStyle timeStyle<br />String locale</td><td><p> Converts the target Calendar into a String using the specified date ( DateStyle) and time ( TimeStyle) styles, and resolving text-based components like month names using the specified locale. </p></td></tr>
<tr class="" bgcolor="#A4A4A4"><td bgcolor="#A4A4A4" colspan="4"></td></tr>
<tr class="a"><td><b>truncate</b></td><td>Function<Date,Date></td><td>int calendarField</td><td><p> Truncates the target Date, setting the specified field as the most significant field. </p> <p> Based on <tt>org.apache.commons.lang.time.DateUtils.truncate()</tt>. </p></td></tr>
</tbody></table>
</div>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">
Copyright © 2012
<a href="https://www.op4j.org">The OP4J team</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>