View Javadoc
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.internal.impl.model;
20  
21  import java.text.SimpleDateFormat;
22  import java.time.Instant;
23  import java.util.Date;
24  import java.util.GregorianCalendar;
25  import java.util.Map;
26  import java.util.Properties;
27  import java.util.TimeZone;
28  
29  /**
30   * MavenBuildTimestamp
31   */
32  public class MavenBuildTimestamp {
33      // ISO 8601-compliant timestamp for machine readability
34      public static final String DEFAULT_BUILD_TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
35  
36      public static final String BUILD_TIMESTAMP_FORMAT_PROPERTY = "maven.build.timestamp.format";
37  
38      public static final TimeZone DEFAULT_BUILD_TIME_ZONE = TimeZone.getTimeZone("Etc/UTC");
39  
40      private String formattedTimestamp;
41  
42      public MavenBuildTimestamp() {
43          this(Instant.now());
44      }
45  
46      public MavenBuildTimestamp(Instant time) {
47          this(time, DEFAULT_BUILD_TIMESTAMP_FORMAT);
48      }
49  
50      public MavenBuildTimestamp(Instant time, Map<String, String> properties) {
51          this(time, properties != null ? properties.get(BUILD_TIMESTAMP_FORMAT_PROPERTY) : null);
52      }
53  
54      /**
55       *
56       * @deprecated Use {@link #MavenBuildTimestamp(Instant, Map)} or extract the format and pass it
57       *             to {@link #MavenBuildTimestamp(Instant, String)} instead.
58       */
59      @Deprecated
60      public MavenBuildTimestamp(Instant time, Properties properties) {
61          this(time, properties != null ? properties.getProperty(BUILD_TIMESTAMP_FORMAT_PROPERTY) : null);
62      }
63  
64      public MavenBuildTimestamp(Instant time, String timestampFormat) {
65          if (timestampFormat == null) {
66              timestampFormat = DEFAULT_BUILD_TIMESTAMP_FORMAT;
67          }
68          if (time == null) {
69              time = Instant.now();
70          }
71          SimpleDateFormat dateFormat = new SimpleDateFormat(timestampFormat);
72          dateFormat.setCalendar(new GregorianCalendar());
73          dateFormat.setTimeZone(DEFAULT_BUILD_TIME_ZONE);
74          formattedTimestamp = dateFormat.format(new Date(time.toEpochMilli()));
75      }
76  
77      public String formattedTimestamp() {
78          return formattedTimestamp;
79      }
80  }