    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.lang3.time;
    019
    020import java.util.Calendar;
    021import java.util.Objects;
    022
    023/**
    024 * Helps use {@link Calendar}s.
    025 *
    026 * @since 3.10
    027 */
    028public class CalendarUtils {
    029
    030    /**
    031     * The singleton instance for {@link Calendar#getInstance()}.
    032     */
    033    public static final CalendarUtils INSTANCE = new CalendarUtils(Calendar.getInstance());
    034
    035    private final Calendar calendar;
    036
    037    /**
    038     * Creates an instance for the given Calendar.
    039     *
    040     * @param calendar A Calendar.
    041     */
    042    public CalendarUtils(final Calendar calendar) {
    043        this.calendar = Objects.requireNonNull(calendar, "calendar");
    044    }
    045
    046    /**
    047     * Gets the current day of month.
    048     *
    049     * @return the current day of month.
    050     */
    051    public int getDayOfMonth() {
    052        return calendar.get(Calendar.DAY_OF_MONTH);
    053    }
    054
    055    /**
    056     * Gets the current month.
    057     *
    058     * @return the current month.
    059     */
    060    public int getMonth() {
    061        return calendar.get(Calendar.MONTH);
    062    }
    063
    064    /**
    065     * Gets the current year.
    066     *
    067     * @return the current year.
    068     */
    069    public int getYear() {
    070        return calendar.get(Calendar.YEAR);
    071    }
    072}