com.helger.holiday.HolidayHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-holiday Show documentation
Java holiday library
There is a newer version: 7.0.0
/**
 * Copyright (C) 2014-2017 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.holiday;

import java.time.LocalDate;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.datetime.PDTFactory;
import com.helger.datetime.util.PDTHelper;

/**
 * Some holiday utility methods.
 *
 * @author Philip Helger
 */
@Immutable
public final class HolidayHelper
{
  private HolidayHelper ()
  {}

  public static boolean isWorkDay (@Nonnull final LocalDate aDate, @Nonnull final IHolidayManager aHolidayMgr)
  {
    return PDTHelper.isWorkDay (aDate) && !aHolidayMgr.isHoliday (aDate);
  }

  /**
   * Get the number of working days between start date (incl.) and end date
   * (incl.). An optional holiday calculator can be used as well.
   *
   * @param aStartDate
   *        The start date. May not be null.
   * @param aEndDate
   *        The end date. May not be null.
   * @param aHolidayMgr
   *        The holiday calculator to use. May not be null.
   * @return The number of working days. If start date is after end date, the
   *         value will be negative! If start date equals end date the return
   *         will be 1 if it is a working day.
   */
  public static int getWorkingDays (@Nonnull final LocalDate aStartDate,
                                    @Nonnull final LocalDate aEndDate,
                                    @Nonnull final IHolidayManager aHolidayMgr)
  {
    ValueEnforcer.notNull (aStartDate, "StartDate");
    ValueEnforcer.notNull (aEndDate, "EndDate");
    ValueEnforcer.notNull (aHolidayMgr, "HolidayMgr");

    final boolean bFlip = aStartDate.isAfter (aEndDate);
    LocalDate aCurDate = bFlip ? aEndDate : aStartDate;
    final LocalDate aRealEndDate = bFlip ? aStartDate : aEndDate;

    int ret = 0;
    while (!aRealEndDate.isBefore (aCurDate))
    {
      if (isWorkDay (aCurDate, aHolidayMgr))
        ret++;
      aCurDate = aCurDate.plusDays (1);
    }
    return bFlip ? -1 * ret : ret;
  }

  /**
   * Get the next working day based on the current day. If the current day is a
   * working day, the current day is returned. A working day is determined by:
   * it's not a weekend day (usually Saturday and Sunday) and it's not a holiday
   * (based on the holiday manager).
   *
   * @param aHolidayMgr
   *        An optional holiday calculator to be used. May be null.
   * @return The next matching date.
   * @see HolidayHelper#isWorkDay(LocalDate, IHolidayManager)
   * @see CalendarHelper#getCurrentOrNextWorkDay()
   */
  @Nonnull
  public static LocalDate getCurrentOrNextWorkDay (@Nullable final IHolidayManager aHolidayMgr)
  {
    if (aHolidayMgr == null)
      return CalendarHelper.getCurrentOrNextWorkDay ();
    LocalDate aDT = PDTFactory.getCurrentLocalDate ();
    while (!isWorkDay (aDT, aHolidayMgr))
      aDT = aDT.plusDays (1);
    return aDT;
  }
}