1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.resources;
20
21 import java.text.SimpleDateFormat;
22 import java.util.Date;
23 import java.util.GregorianCalendar;
24 import java.util.Properties;
25 import java.util.TimeZone;
26
27 /**
28 * This class is duplicated from maven-model-builder from maven core. (See MRESOURCES-99).
29 */
30 public class MavenBuildTimestamp {
31 /**
32 * ISO 8601-compliant timestamp for machine readability
33 */
34 public static final String DEFAULT_BUILD_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
35
36 /**
37 * The property name.
38 */
39 public static final String BUILD_TIMESTAMP_FORMAT_PROPERTY = "maven.build.timestamp.format";
40
41 /**
42 * The default time zone {@code Etc/UTC}.
43 */
44 public static final TimeZone DEFAULT_BUILD_TIME_ZONE = TimeZone.getTimeZone("Etc/UTC");
45
46 private String formattedTimestamp;
47
48 /**
49 * Create an instance.
50 */
51 public MavenBuildTimestamp() {
52 this(new Date());
53 }
54
55 /**
56 * @param time The time to use.
57 */
58 public MavenBuildTimestamp(Date time) {
59 this(time, DEFAULT_BUILD_TIMESTAMP_FORMAT);
60 }
61
62 /**
63 * @param time The time to use.
64 * @param properties the properties which can be define. can be {@code null}
65 */
66 public MavenBuildTimestamp(Date time, Properties properties) {
67 this(time, properties != null ? properties.getProperty(BUILD_TIMESTAMP_FORMAT_PROPERTY) : null);
68 }
69
70 /**
71 * @param time The time to use.
72 * @param timestampFormat The format for {@link SimpleDateFormat}.
73 */
74 public MavenBuildTimestamp(Date time, String timestampFormat) {
75 SimpleDateFormat dateFormat;
76
77 if (timestampFormat == null) {
78 dateFormat = new SimpleDateFormat(DEFAULT_BUILD_TIMESTAMP_FORMAT);
79 } else {
80 dateFormat = new SimpleDateFormat(timestampFormat);
81 }
82
83 dateFormat.setCalendar(new GregorianCalendar());
84 dateFormat.setTimeZone(DEFAULT_BUILD_TIME_ZONE);
85
86 if (time == null) {
87 formattedTimestamp = dateFormat.format(new Date());
88 } else {
89 formattedTimestamp = dateFormat.format(time);
90 }
91 }
92
93 /**
94 * @return The formatted time stamp.
95 */
96 public String formattedTimestamp() {
97 return formattedTimestamp;
98 }
99 }