source: josm/trunk/src/org/openstreetmap/josm/tools/date/DateUtils.java@ 12783

Last change on this file since 12783 was 12620, checked in by Don-vip, 7 years ago

see #15182 - deprecate all Main logging methods and introduce suitable replacements in Logging for most of them
  • Property svn:eol-style set to native
File size: 12.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.tools.date;
3
4import java.text.DateFormat;
5import java.text.ParsePosition;
6import java.text.SimpleDateFormat;
7import java.time.Instant;
8import java.time.ZoneId;
9import java.time.ZoneOffset;
10import java.time.ZonedDateTime;
11import java.time.format.DateTimeFormatter;
12import java.util.Date;
13import java.util.Locale;
14import java.util.TimeZone;
15import java.util.concurrent.TimeUnit;
16
17import javax.xml.datatype.DatatypeConfigurationException;
18import javax.xml.datatype.DatatypeFactory;
19
20import org.openstreetmap.josm.data.preferences.BooleanProperty;
21import org.openstreetmap.josm.tools.CheckParameterUtil;
22import org.openstreetmap.josm.tools.Logging;
23import org.openstreetmap.josm.tools.UncheckedParseException;
24
25/**
26 * A static utility class dealing with:
27 * <ul>
28 * <li>parsing XML date quickly and formatting a date to the XML UTC format regardless of current locale</li>
29 * <li>providing a single entry point for formatting dates to be displayed in JOSM GUI, based on user preferences</li>
30 * </ul>
31 * @author nenik
32 */
33public final class DateUtils {
34
35 /**
36 * The UTC time zone.
37 */
38 public static final TimeZone UTC = TimeZone.getTimeZone("UTC");
39
40 /**
41 * Property to enable display of ISO dates globally.
42 * @since 7299
43 */
44 public static final BooleanProperty PROP_ISO_DATES = new BooleanProperty("iso.dates", false);
45
46 private static final DatatypeFactory XML_DATE;
47
48 static {
49 DatatypeFactory fact = null;
50 try {
51 fact = DatatypeFactory.newInstance();
52 } catch (DatatypeConfigurationException e) {
53 Logging.error(e);
54 }
55 XML_DATE = fact;
56 }
57
58 /**
59 * Constructs a new {@code DateUtils}.
60 */
61 private DateUtils() {
62 // Hide default constructor for utils classes
63 }
64
65 /**
66 * Parses XML date quickly, regardless of current locale.
67 * @param str The XML date as string
68 * @return The date
69 * @throws UncheckedParseException if the date does not match any of the supported date formats
70 */
71 public static synchronized Date fromString(String str) {
72 return new Date(tsFromString(str));
73 }
74
75 /**
76 * Parses XML date quickly, regardless of current locale.
77 * @param str The XML date as string
78 * @return The date in milliseconds since epoch
79 * @throws UncheckedParseException if the date does not match any of the supported date formats
80 */
81 public static synchronized long tsFromString(String str) {
82 // "2007-07-25T09:26:24{Z|{+|-}01[:00]}"
83 if (checkLayout(str, "xxxx-xx-xxTxx:xx:xxZ") ||
84 checkLayout(str, "xxxx-xx-xxTxx:xx:xx") ||
85 checkLayout(str, "xxxx:xx:xx xx:xx:xx") ||
86 checkLayout(str, "xxxx-xx-xx xx:xx:xxZ") ||
87 checkLayout(str, "xxxx-xx-xx xx:xx:xx UTC") ||
88 checkLayout(str, "xxxx-xx-xxTxx:xx:xx+xx") ||
89 checkLayout(str, "xxxx-xx-xxTxx:xx:xx-xx") ||
90 checkLayout(str, "xxxx-xx-xxTxx:xx:xx+xx:00") ||
91 checkLayout(str, "xxxx-xx-xxTxx:xx:xx-xx:00")) {
92 final ZonedDateTime local = ZonedDateTime.of(
93 parsePart4(str, 0),
94 parsePart2(str, 5),
95 parsePart2(str, 8),
96 parsePart2(str, 11),
97 parsePart2(str, 14),
98 parsePart2(str, 17),
99 0,
100 // consider EXIF date in default timezone
101 checkLayout(str, "xxxx:xx:xx xx:xx:xx") ? ZoneId.systemDefault() : ZoneOffset.UTC
102 );
103 if (str.length() == 22 || str.length() == 25) {
104 final int plusHr = parsePart2(str, 20);
105 final long mul = str.charAt(19) == '+' ? -1 : 1;
106 return local.plusHours(plusHr * mul).toInstant().toEpochMilli();
107 }
108 return local.toInstant().toEpochMilli();
109 } else if (checkLayout(str, "xxxx-xx-xxTxx:xx:xx.xxxZ") ||
110 checkLayout(str, "xxxx-xx-xxTxx:xx:xx.xxx") ||
111 checkLayout(str, "xxxx:xx:xx xx:xx:xx.xxx") ||
112 checkLayout(str, "xxxx-xx-xxTxx:xx:xx.xxx+xx:00") ||
113 checkLayout(str, "xxxx-xx-xxTxx:xx:xx.xxx-xx:00")) {
114 final ZonedDateTime local = ZonedDateTime.of(
115 parsePart4(str, 0),
116 parsePart2(str, 5),
117 parsePart2(str, 8),
118 parsePart2(str, 11),
119 parsePart2(str, 14),
120 parsePart2(str, 17),
121 parsePart3(str, 20) * 1_000_000,
122 // consider EXIF date in default timezone
123 checkLayout(str, "xxxx:xx:xx xx:xx:xx.xxx") ? ZoneId.systemDefault() : ZoneOffset.UTC
124 );
125 if (str.length() == 29) {
126 final int plusHr = parsePart2(str, 24);
127 final long mul = str.charAt(23) == '+' ? -1 : 1;
128 return local.plusHours(plusHr * mul).toInstant().toEpochMilli();
129 }
130 return local.toInstant().toEpochMilli();
131 } else {
132 // example date format "18-AUG-08 13:33:03"
133 SimpleDateFormat f = new SimpleDateFormat("dd-MMM-yy HH:mm:ss");
134 Date d = f.parse(str, new ParsePosition(0));
135 if (d != null)
136 return d.getTime();
137 }
138
139 try {
140 return XML_DATE.newXMLGregorianCalendar(str).toGregorianCalendar().getTimeInMillis();
141 } catch (IllegalArgumentException ex) {
142 throw new UncheckedParseException("The date string (" + str + ") could not be parsed.", ex);
143 }
144 }
145
146 /**
147 * Formats a date to the XML UTC format regardless of current locale.
148 * @param timestamp number of seconds since the epoch
149 * @return The formatted date
150 */
151 public static synchronized String fromTimestamp(int timestamp) {
152 final ZonedDateTime temporal = Instant.ofEpochMilli(TimeUnit.SECONDS.toMillis(timestamp)).atZone(ZoneOffset.UTC);
153 return DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(temporal);
154 }
155
156 /**
157 * Formats a date to the XML UTC format regardless of current locale.
158 * @param date The date to format
159 * @return The formatted date
160 */
161 public static synchronized String fromDate(Date date) {
162 final ZonedDateTime temporal = date.toInstant().atZone(ZoneOffset.UTC);
163 return DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(temporal);
164 }
165
166 /**
167 * Null-safe date cloning method.
168 * @param d date to clone, or null
169 * @return cloned date, or null
170 * @since 11878
171 */
172 public static Date cloneDate(Date d) {
173 return d != null ? (Date) d.clone() : null;
174 }
175
176 private static boolean checkLayout(String text, String pattern) {
177 if (text.length() != pattern.length())
178 return false;
179 for (int i = 0; i < pattern.length(); i++) {
180 char pc = pattern.charAt(i);
181 char tc = text.charAt(i);
182 if (pc == 'x' && Character.isDigit(tc))
183 continue;
184 else if (pc == 'x' || pc != tc)
185 return false;
186 }
187 return true;
188 }
189
190 private static int num(char c) {
191 return c - '0';
192 }
193
194 private static int parsePart2(String str, int off) {
195 return 10 * num(str.charAt(off)) + num(str.charAt(off + 1));
196 }
197
198 private static int parsePart3(String str, int off) {
199 return 100 * num(str.charAt(off)) + 10 * num(str.charAt(off + 1)) + num(str.charAt(off + 2));
200 }
201
202 private static int parsePart4(String str, int off) {
203 return 1000 * num(str.charAt(off)) + 100 * num(str.charAt(off + 1)) + 10 * num(str.charAt(off + 2)) + num(str.charAt(off + 3));
204 }
205
206 /**
207 * Returns a new {@code SimpleDateFormat} for date only, according to <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>.
208 * @return a new ISO 8601 date format, for date only.
209 * @since 7299
210 */
211 public static SimpleDateFormat newIsoDateFormat() {
212 return new SimpleDateFormat("yyyy-MM-dd");
213 }
214
215 /**
216 * Returns a new {@code SimpleDateFormat} for date and time, according to <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>.
217 * @return a new ISO 8601 date format, for date and time.
218 * @since 7299
219 */
220 public static SimpleDateFormat newIsoDateTimeFormat() {
221 return new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssX");
222 }
223
224 /**
225 * Returns a new {@code SimpleDateFormat} for date and time, according to format used in OSM API errors.
226 * @return a new date format, for date and time, to use for OSM API error handling.
227 * @since 7299
228 */
229 public static SimpleDateFormat newOsmApiDateTimeFormat() {
230 // Example: "2010-09-07 14:39:41 UTC".
231 // Always parsed with US locale regardless of the current locale in JOSM
232 return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z", Locale.US);
233 }
234
235 /**
236 * Returns the date format to be used for current user, based on user preferences.
237 * @param dateStyle The date style as described in {@link DateFormat#getDateInstance}. Ignored if "ISO dates" option is set
238 * @return The date format
239 * @since 7299
240 */
241 public static DateFormat getDateFormat(int dateStyle) {
242 if (PROP_ISO_DATES.get()) {
243 return newIsoDateFormat();
244 } else {
245 return DateFormat.getDateInstance(dateStyle, Locale.getDefault());
246 }
247 }
248
249 /**
250 * Formats a date to be displayed to current user, based on user preferences.
251 * @param date The date to display. Must not be {@code null}
252 * @param dateStyle The date style as described in {@link DateFormat#getDateInstance}. Ignored if "ISO dates" option is set
253 * @return The formatted date
254 * @since 7299
255 */
256 public static String formatDate(Date date, int dateStyle) {
257 CheckParameterUtil.ensureParameterNotNull(date, "date");
258 return getDateFormat(dateStyle).format(date);
259 }
260
261 /**
262 * Returns the time format to be used for current user, based on user preferences.
263 * @param timeStyle The time style as described in {@link DateFormat#getTimeInstance}. Ignored if "ISO dates" option is set
264 * @return The time format
265 * @since 7299
266 */
267 public static DateFormat getTimeFormat(int timeStyle) {
268 if (PROP_ISO_DATES.get()) {
269 // This is not strictly conform to ISO 8601. We just want to avoid US-style times such as 3.30pm
270 return new SimpleDateFormat("HH:mm:ss");
271 } else {
272 return DateFormat.getTimeInstance(timeStyle, Locale.getDefault());
273 }
274 }
275
276 /**
277 * Formats a time to be displayed to current user, based on user preferences.
278 * @param time The time to display. Must not be {@code null}
279 * @param timeStyle The time style as described in {@link DateFormat#getTimeInstance}. Ignored if "ISO dates" option is set
280 * @return The formatted time
281 * @since 7299
282 */
283 public static String formatTime(Date time, int timeStyle) {
284 CheckParameterUtil.ensureParameterNotNull(time, "time");
285 return getTimeFormat(timeStyle).format(time);
286 }
287
288 /**
289 * Returns the date/time format to be used for current user, based on user preferences.
290 * @param dateStyle The date style as described in {@link DateFormat#getDateTimeInstance}. Ignored if "ISO dates" option is set
291 * @param timeStyle The time style as described in {@code DateFormat.getDateTimeInstance}. Ignored if "ISO dates" option is set
292 * @return The date/time format
293 * @since 7299
294 */
295 public static DateFormat getDateTimeFormat(int dateStyle, int timeStyle) {
296 if (PROP_ISO_DATES.get()) {
297 // This is not strictly conform to ISO 8601. We just want to avoid US-style times such as 3.30pm
298 // and we don't want to use the 'T' separator as a space character is much more readable
299 return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
300 } else {
301 return DateFormat.getDateTimeInstance(dateStyle, timeStyle, Locale.getDefault());
302 }
303 }
304
305 /**
306 * Formats a date/time to be displayed to current user, based on user preferences.
307 * @param datetime The date/time to display. Must not be {@code null}
308 * @param dateStyle The date style as described in {@link DateFormat#getDateTimeInstance}. Ignored if "ISO dates" option is set
309 * @param timeStyle The time style as described in {@code DateFormat.getDateTimeInstance}. Ignored if "ISO dates" option is set
310 * @return The formatted date/time
311 * @since 7299
312 */
313 public static String formatDateTime(Date datetime, int dateStyle, int timeStyle) {
314 CheckParameterUtil.ensureParameterNotNull(datetime, "datetime");
315 return getDateTimeFormat(dateStyle, timeStyle).format(datetime);
316 }
317}
Note: See TracBrowser for help on using the repository browser.