org.quartz.core.Calendar Maven / Gradle / Ivy

Go to download
/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * 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 org.quartz.core;

import org.quartz.triggers.Trigger;

/**
 * An interface to be implemented by objects that define spaces of time during which an associated {@link Trigger} may (not) fire.
 * Calendars do not define actual fire times, but rather are used to limit a Trigger from firing on its normal schedule if necessary.
 * Most Calendars include all times by default and allow the user to specify times to exclude.
 * 
 * As such, it is often useful to think of Calendars as being used to exclude a block of time - as opposed to include a block of time.
 * (i.e. the schedule "fire every five minutes except on Sundays" could be implemented with a SimpleTrigger and a
 * WeeklyCalendar which excludes Sundays)
 * 
 * 
 * Implementations MUST take care of being properly Cloneable and Serializable.
 * 
 * 
 * @author James House
 * @author Juergen Donnerstag
 */
public interface Calendar extends java.io.Serializable, java.lang.Cloneable {

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interface.
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  /**
   * 
   * Determine whether the given time (in milliseconds) is 'included' by the Calendar.
   * 
   */
  boolean isTimeIncluded(long timeStamp);

  Object clone();
}