/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2001, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol;
import java.util.Calendar;
import java.util.Date;
import net.sourceforge.cruisecontrol.util.DateUtil;
import net.sourceforge.cruisecontrol.util.PerDayScheduleItem;
import net.sourceforge.cruisecontrol.util.ValidationHelper;
/**
* Used by <code>Schedule</code> to define periods of time when CruiseControl should not even attempt a build. Useful
* for making sure CruiseControl does not run during server backup times, etc.
*
* @author Alden Almagro
*/
public class PauseBuilder extends PerDayScheduleItem {
private static final long serialVersionUID = 866530246895228766L;
private int startTime = PerDayScheduleItem.NOT_SET;
private int endTime = PerDayScheduleItem.NOT_SET;
public void validate() throws CruiseControlException {
ValidationHelper.assertFalse(startTime < 0, "'starttime' is a required attribute on PauseBuilder");
ValidationHelper.assertFalse(endTime < 0, "'endtime' is a required attribute on PauseBuilder");
ValidationHelper.assertFalse(getDay() == INVALID_NAME_OF_DAY,
"setDay attribute on PauseBuilder requires english name for day of week (case insensitive)");
}
public void setStartTime(int time) {
startTime = time;
}
public void setEndTime(int time) {
endTime = time;
}
public int getStartTime() {
return startTime;
}
public int getEndTime() {
return endTime;
}
/**
* Determine if the build is paused at the given time.
*
* @param date
* Date set to current date/time
* @return true if the build is paused at date
*/
public boolean isPaused(Date date) {
Calendar now = Calendar.getInstance();
now.setTime(date);
int currentDay = now.get(Calendar.DAY_OF_WEEK);
int currentTime = DateUtil.getTimeFromDate(date);
int builderDay = getDay();
boolean isValidDay = ((builderDay < 0) || (builderDay == currentDay));
if (startTime < endTime) {
return (startTime <= currentTime && currentTime <= endTime && isValidDay);
}
return ((startTime <= currentTime && (builderDay < 0 || builderDay == currentDay))
|| (currentTime <= endTime && (builderDay < 0 || builderDay == (currentDay - 1))));
}
}