1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.lang3.time;
19
20 import java.util.TimeZone;
21
22 import org.apache.commons.lang3.ObjectUtils;
23
24 /**
25 * Helps to deal with {@link java.util.TimeZone}s.
26 *
27 * @since 3.7
28 */
29 public class TimeZones {
30
31 /**
32 * A public version of {@link java.util.TimeZone}'s package private {@code GMT_ID} field.
33 */
34 public static final String GMT_ID = "GMT";
35
36 /**
37 * The GMT time zone.
38 *
39 * @since 3.13.0
40 */
41 public static final TimeZone GMT = TimeZone.getTimeZone(GMT_ID);
42
43 /**
44 * Returns the given TimeZone if non-{@code null}, otherwise {@link TimeZone#getDefault()}.
45 *
46 * @param timeZone a locale or {@code null}.
47 * @return the given locale if non-{@code null}, otherwise {@link TimeZone#getDefault()}.
48 * @since 3.13.0
49 */
50 public static TimeZone toTimeZone(final TimeZone timeZone) {
51 return ObjectUtils.getIfNull(timeZone, TimeZone::getDefault);
52 }
53
54 /** Do not instantiate. */
55 private TimeZones() {
56 }
57
58 }