aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/util/GitDateFormatter.java
blob: 332e65985e94e2d2d165c237b13693864b00febb (plain)
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
/*
 * Copyright (C) 2011, 2012 Robin Rosenberg and others
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0 which is available at
 * https://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

package org.eclipse.jgit.util;

import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.Locale;

import org.eclipse.jgit.lib.PersonIdent;

/**
 * A utility for formatting dates according to the Git log.date formats plus
 * extensions.
 * <p>
 * The enum {@link org.eclipse.jgit.util.GitDateFormatter.Format} defines the
 * available types.
 */
public class GitDateFormatter {

	private DateTimeFormatter dateTimeFormat;

	private DateTimeFormatter dateTimeFormat2;

	private final Format format;

	/**
	 * Git and JGit formats
	 */
	public enum Format {

		/**
		 * Git format: Time and original time zone
		 */
		DEFAULT,

		/**
		 * Git format: Relative time stamp
		 */
		RELATIVE,

		/**
		 * Git format: Date and time in local time zone
		 */
		LOCAL,

		/**
		 * Git format: ISO 8601 plus time zone
		 */
		ISO,

		/**
		 * Git formt: RFC 2822 plus time zone
		 */
		RFC,

		/**
		 * Git format: YYYY-MM-DD
		 */
		SHORT,

		/**
		 * Git format: Seconds size 1970 in UTC plus time zone
		 */
		RAW,

		/**
		 * Locale dependent formatting with original time zone
		 */
		LOCALE,

		/**
		 * Locale dependent formatting in local time zone
		 */
		LOCALELOCAL
	}

	/**
	 * Create a new Git oriented date formatter
	 *
	 * @param format
	 *            a {@link org.eclipse.jgit.util.GitDateFormatter.Format}
	 *            object.
	 */
	public GitDateFormatter(Format format) {
		this.format = format;
		switch (format) {
		default:
			break;
		case DEFAULT: // Not default:
			dateTimeFormat = DateTimeFormatter.ofPattern(
					"EEE MMM dd HH:mm:ss yyyy Z", Locale.US); //$NON-NLS-1$
			break;
		case ISO:
			dateTimeFormat = DateTimeFormatter.ofPattern(
					"yyyy-MM-dd HH:mm:ss Z", //$NON-NLS-1$
					Locale.US);
			break;
		case LOCAL:
			dateTimeFormat = DateTimeFormatter.ofPattern(
					"EEE MMM dd HH:mm:ss yyyy", //$NON-NLS-1$
					Locale.US);
			break;
		case RFC:
			dateTimeFormat = DateTimeFormatter.ofPattern(
					"EEE, dd MMM yyyy HH:mm:ss Z", Locale.US); //$NON-NLS-1$
			break;
		case SHORT:
			dateTimeFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd", //$NON-NLS-1$
					Locale.US);
			break;
		case LOCALE:
		case LOCALELOCAL:
			dateTimeFormat = DateTimeFormatter
					.ofLocalizedDateTime(FormatStyle.MEDIUM)
					.withLocale(Locale.US);
			dateTimeFormat2 = DateTimeFormatter.ofPattern("Z", //$NON-NLS-1$
					Locale.US);
			break;
		}
	}

	/**
	 * Format committer, author or tagger ident according to this formatter's
	 * specification.
	 *
	 * @param ident
	 *            a {@link org.eclipse.jgit.lib.PersonIdent} object.
	 * @return formatted version of date, time and time zone
	 */
	@SuppressWarnings("boxing")
	public String formatDate(PersonIdent ident) {
		switch (format) {
		case RAW: {
			int offset = ident.getZoneOffset().getTotalSeconds();
			String sign = offset < 0 ? "-" : "+"; //$NON-NLS-1$ //$NON-NLS-2$
			int offset2;
			if (offset < 0) {
				offset2 = -offset;
			} else {
				offset2 = offset;
			}
			int minutes = (offset2 / 60) % 60;
			int hours = offset2 / 60 / 60;
			return String.format("%d %s%02d%02d", //$NON-NLS-1$
					ident.getWhenAsInstant().getEpochSecond(), sign, hours,
					minutes);
		}
		case RELATIVE:
			return RelativeDateFormatter.format(ident.getWhenAsInstant());
		case LOCALELOCAL:
		case LOCAL:
			return dateTimeFormat
					.withZone(SystemReader.getInstance().getTimeZoneId())
					.format(ident.getWhenAsInstant());
		case LOCALE: {
			ZoneId tz = ident.getZoneId();
			if (tz == null) {
				tz = SystemReader.getInstance().getTimeZoneId();
			}
			return dateTimeFormat.withZone(tz).format(ident.getWhenAsInstant())
					+ " " //$NON-NLS-1$
					+ dateTimeFormat2.withZone(tz)
							.format(ident.getWhenAsInstant());
		}
		default: {
			ZoneId tz = ident.getZoneId();
			if (tz == null) {
				tz = SystemReader.getInstance().getTimeZoneId();
			}
			return dateTimeFormat.withZone(tz).format(ident.getWhenAsInstant());
		}
		}
	}
}