diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 34d0c327f..f55297f1f 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -76,6 +76,7 @@ The type attribute can be add,update,fix,remove. com.puppycrawl.tools:checkstyle 8.24 -> 8.25. Update documentation related to the issue LANG-696 #449. AnnotationUtils little cleanup #467. + Add org.apache.commons.lang3.time.Calendars. diff --git a/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java b/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java new file mode 100644 index 000000000..b9899cae9 --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java @@ -0,0 +1,73 @@ +/* + * 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.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()); + + private final Calendar calendar; + + /** + * Creates an instance for the given Calendar. + * + * @param calendar A Calendar. + */ + public CalendarUtils(final Calendar calendar) { + super(); + this.calendar = Objects.requireNonNull(calendar, "calendar"); + } + + /** + * 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 month. + * + * @return the current month. + */ + public int getMonth() { + return calendar.get(Calendar.MONTH); + } + + /** + * Gets the current year. + * + * @return the current year. + */ + public int getYear() { + return calendar.get(Calendar.YEAR); + } +} diff --git a/src/test/java/org/apache/commons/lang3/time/CalendarUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/CalendarUtilsTest.java new file mode 100644 index 000000000..74ac0097f --- /dev/null +++ b/src/test/java/org/apache/commons/lang3/time/CalendarUtilsTest.java @@ -0,0 +1,43 @@ +/* + * 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 static org.junit.jupiter.api.Assertions.assertEquals; + +import java.util.Calendar; + +import org.junit.jupiter.api.Test; + +public class CalendarUtilsTest { + + @Test + public void testGetYear() { + assertEquals(Calendar.getInstance().get(Calendar.YEAR), CalendarUtils.INSTANCE.getYear()); + } + + @Test + public void testGetMonth() { + assertEquals(Calendar.getInstance().get(Calendar.MONTH), CalendarUtils.INSTANCE.getMonth()); + } + + @Test + public void testGetDayOfMonth() { + assertEquals(Calendar.getInstance().get(Calendar.DAY_OF_MONTH), CalendarUtils.INSTANCE.getDayOfMonth()); + } + +}