org.quartz.impl.calendar.WeeklyCalendar Maven / Gradle / Ivy
/*
* Copyright 2004-2005 OpenSymphony
*
* 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.
*
*/
/*
* Previously Copyright (c) 2001-2004 James House
* and Juergen Donnerstag (c) 2002, EDS 2002
*/
package org.quartz.impl.calendar;
import java.io.Serializable;
import java.util.Date;
import org.quartz.Calendar;
/**
*
* This implementation of the Calendar excludes a set of days of the week. You
* may use it to exclude weekends for example. But you may define any day of
* the week.
*
*
* @see org.quartz.Calendar
* @see org.quartz.impl.calendar.BaseCalendar
*
* @author Juergen Donnerstag
*/
public class WeeklyCalendar extends BaseCalendar implements Calendar,
Serializable {
// An array to store the week days which are to be excluded.
// java.util.Calendar.MONDAY etc. are used as index.
private boolean[] excludeDays = new boolean[8];
// Will be set to true, if all week days are excluded
private boolean excludeAll = false;
/**
*
* Constructor
*
*/
public WeeklyCalendar() {
super();
init();
}
/**
*
* Constructor
*
*/
public WeeklyCalendar(Calendar baseCalendar) {
super(baseCalendar);
init();
}
/**
*
* Initialize internal variables
*
*/
private void init() {
excludeDays[java.util.Calendar.SUNDAY] = true;
excludeDays[java.util.Calendar.SATURDAY] = true;
excludeAll = areAllDaysExcluded();
}
/**
*
* Get the array with the week days
*
*/
public boolean[] getDaysExcluded() {
return excludeDays;
}
/**
*
* Return true, if wday (see Calendar.get()) is defined to be exluded. E. g.
* saturday and sunday.
*
*/
public boolean isDayExcluded(int wday) {
return excludeDays[wday];
}
/**
*
* Redefine the array of days excluded. The array must of size greater or
* equal 8. java.util.Calendar's constants like MONDAY should be used as
* index. A value of true is regarded as: exclude it.
*
*/
public void setDaysExcluded(boolean[] weekDays) {
if (weekDays == null) return;
excludeDays = weekDays;
excludeAll = areAllDaysExcluded();
}
/**
*
* Redefine a certain day of the week to be excluded (true) or included
* (false). Use java.util.Calendar's constants like MONDAY to determine the
* wday.
*
*/
public void setDayExcluded(int wday, boolean exclude) {
excludeDays[wday] = exclude;
excludeAll = areAllDaysExcluded();
}
/**
*
* Check if all week days are excluded. That is no day is included.
*
*
* @return boolean
*/
public boolean areAllDaysExcluded() {
if (isDayExcluded(java.util.Calendar.SUNDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.MONDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.TUESDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.WEDNESDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.THURSDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.FRIDAY) == false) return false;
if (isDayExcluded(java.util.Calendar.SATURDAY) == false) return false;
return true;
}
/**
*
* Determine whether the given time (in milliseconds) is 'included' by the
* Calendar.
*
*
*
* Note that this Calendar is only has full-day precision.
*
*/
public boolean isTimeIncluded(long timeStamp) {
if (excludeAll == true) return false;
// Test the base calendar first. Only if the base calendar not already
// excludes the time/date, continue evaluating this calendar instance.
if (super.isTimeIncluded(timeStamp) == false) { return false; }
java.util.Calendar cl = java.util.Calendar.getInstance();
cl.setTime(new Date(timeStamp));
int wday = cl.get(java.util.Calendar.DAY_OF_WEEK);
return !(isDayExcluded(wday));
}
/**
*
* Determine the next time (in milliseconds) that is 'included' by the
* Calendar after the given time. Return the original value if timeStamp is
* included. Return 0 if all days are excluded.
*
*
*
* Note that this Calendar is only has full-day precision.
*
*/
public long getNextIncludedTime(long timeStamp) {
if (excludeAll == true) return 0;
// Call base calendar implementation first
long baseTime = super.getNextIncludedTime(timeStamp);
if ((baseTime > 0) && (baseTime > timeStamp)) timeStamp = baseTime;
// Get timestamp for 00:00:00
long newTimeStamp = buildHoliday(timeStamp);
java.util.Calendar cl = getJavaCalendar(newTimeStamp);
int wday = cl.get(java.util.Calendar.DAY_OF_WEEK);
if (!isDayExcluded(wday)) return timeStamp; // return the original
// value
while (isDayExcluded(wday) == true) {
cl.add(java.util.Calendar.DATE, 1);
wday = cl.get(java.util.Calendar.DAY_OF_WEEK);
}
return cl.getTime().getTime();
}
}