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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.lang3.time;
import java.util.Calendar;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
/**
* Helps use {@link Calendar}s.
*
* @since 3.10
*/
public class CalendarUtils {
/**
* The singleton instance for {@link Calendar#getInstance()}.
*/
public static final CalendarUtils INSTANCE = new CalendarUtils(Calendar.getInstance());
/**
* Gets a CalendarUtils using the default time zone and specified locale. The <code>CalendarUtils</code> returned is based on the current time in the
* default time zone with the given locale.
*
* @param locale the locale for the week data
* @return a Calendar.
*/
static CalendarUtils getInstance(final Locale locale) {
return new CalendarUtils(Calendar.getInstance(locale), locale);
}
private final Calendar calendar;
private final Locale locale;
/**
* Creates an instance for the given Calendar.
*
* @param calendar A Calendar.
*/
public CalendarUtils(final Calendar calendar) {
this(calendar, Locale.getDefault());
}
/**
* Creates an instance for the given Calendar.
*
* @param calendar A Calendar.
* @param locale A Locale.
*/
CalendarUtils(final Calendar calendar, final Locale locale) {
this.calendar = Objects.requireNonNull(calendar, "calendar");
this.locale = Objects.requireNonNull(locale, "locale");
}
/**
* Gets the current day of month.
*
* @return the current day of month.
*/
public int getDayOfMonth() {
return calendar.get(Calendar.DAY_OF_MONTH);
}
/**
* Gets the current day of year.
*
* @return the current day of year.
* @since 3.13.0
*/
public int getDayOfYear() {
return calendar.get(Calendar.DAY_OF_YEAR);
}
/**
* Gets the current month.
*
* @return the current month.
*/
public int getMonth() {
return calendar.get(Calendar.MONTH);
}
/**
* Gets month names in the requested style.
* @param style Must be a valid {@link Calendar#getDisplayNames(int, int, Locale)} month style.
* @return Styled names of months
*/
String[] getMonthDisplayNames(final int style) {
// Unfortunately standalone month names are not available in DateFormatSymbols,
// so we have to extract them.
final Map<String, Integer> displayNames = calendar.getDisplayNames(Calendar.MONTH, style, locale);
if (displayNames == null) {
return null;
}
final String[] monthNames = new String[displayNames.size()];
displayNames.forEach((k, v) -> monthNames[v] = k);
return monthNames;
}
/**
* Gets full standalone month names as used in "LLLL" date formatting.
* @return Long names of months
*/
String[] getStandaloneLongMonthNames() {
return getMonthDisplayNames(Calendar.LONG_STANDALONE);
}
/**
* Gets short standalone month names as used in "LLLL" date formatting.
* @return Short names of months
*/
String[] getStandaloneShortMonthNames() {
return getMonthDisplayNames(Calendar.SHORT_STANDALONE);
}
/**
* Gets the current year.
*
* @return the current year.
*/
public int getYear() {
return calendar.get(Calendar.YEAR);
}
}
|
