com.helger.quartz.impl.calendar.HolidayCalendar Maven / Gradle / Ivy

/**
 * All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
 *
 * Copyright (C) 2016-2020 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.quartz.impl.calendar;

import java.util.Calendar;
import java.util.Collections;
import java.util.Date;
import java.util.SortedSet;
import java.util.TimeZone;

import javax.annotation.Nonnull;

import com.helger.commons.collection.impl.CommonsTreeSet;
import com.helger.commons.collection.impl.ICommonsSortedSet;
import com.helger.quartz.ICalendar;

/**
 * 
 * This implementation of the Calendar stores a list of holidays (full days that
 * are excluded from scheduling).
 * 
 * 
 * The implementation DOES take the year into consideration, so if you want to
 * exclude July 4th for the next 10 years, you need to add 10 entries to the
 * exclude list.
 * 
 *
 * @author Sharada Jambula
 * @author Juergen Donnerstag
 */
public class HolidayCalendar extends AbstractCalendar 
{
  // A sorted set to store the holidays
  private final ICommonsSortedSet  m_aDates = new CommonsTreeSet <> ();

  public HolidayCalendar (@Nonnull final HolidayCalendar aOther)
  {
    super (aOther);
    m_aDates.addAll (aOther.m_aDates);
  }

  public HolidayCalendar ()
  {
    this (null, null);
  }

  public HolidayCalendar (final ICalendar baseCalendar)
  {
    this (baseCalendar, null);
  }

  public HolidayCalendar (final TimeZone timeZone)
  {
    this (null, timeZone);
  }

  public HolidayCalendar (final ICalendar baseCalendar, final TimeZone timeZone)
  {
    super (baseCalendar, timeZone);
  }

  /**
   * 
   * Determine whether the given time (in milliseconds) is 'included' by the
   * Calendar.
   * 
   * 
   * Note that this Calendar is only has full-day precision.
   * 
   */
  @Override
  public boolean isTimeIncluded (final long timeStamp)
  {
    if (!super.isTimeIncluded (timeStamp))
      return false;

    final Date lookFor = getStartOfDayJavaCalendar (timeStamp).getTime ();
    return !m_aDates.contains (lookFor);
  }

  /**
   * Determine the next time (in milliseconds) that is 'included' by the
   * Calendar after the given time.

   * Note that this Calendar is only has full-day precision.
   */
  @Override
  public long getNextIncludedTime (final long nTimeStamp)
  {
    // Call base calendar implementation first
    long timeStamp = nTimeStamp;
    final long baseTime = super.getNextIncludedTime (timeStamp);
    if (baseTime > 0 && baseTime > timeStamp)
    {
      timeStamp = baseTime;
    }

    // Get timestamp for 00:00:00
    final Calendar day = getStartOfDayJavaCalendar (timeStamp);
    while (!isTimeIncluded (day.getTime ().getTime ()))
    {
      day.add (Calendar.DAY_OF_MONTH, 1);
    }

    return day.getTime ().getTime ();
  }

  /**
   * Add the given Date to the list of excluded days. Only the month, day and
   * year of the returned dates are significant.
   */
  public void addExcludedDate (final Date excludedDate)
  {
    final Date date = getStartOfDayJavaCalendar (excludedDate.getTime ()).getTime ();
    /*
     * System.err.println( "HolidayCalendar.add(): date=" +
     * excludedDate.toLocaleString());
     */
    m_aDates.add (date);
  }

  public void removeExcludedDate (final Date dateToRemove)
  {
    final Date date = getStartOfDayJavaCalendar (dateToRemove.getTime ()).getTime ();
    m_aDates.remove (date);
  }

  /**
   * 
   * Returns a SortedSet of Dates representing the excluded days.
   * Only the month, day and year of the returned dates are significant.
   * 
   */
  public SortedSet  getExcludedDates ()
  {
    return Collections.unmodifiableSortedSet (m_aDates);
  }

  @Override
  @Nonnull
  public HolidayCalendar getClone ()
  {
    return new HolidayCalendar (this);
  }
}