001: /********************************************************************************
002: * CruiseControl, a Continuous Integration Toolkit
003: * Copyright (c) 2001, ThoughtWorks, Inc.
004: * 200 E. Randolph, 25th Floor
005: * Chicago, IL 60601 USA
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * + Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * + Redistributions in binary form must reproduce the above
016: * copyright notice, this list of conditions and the following
017: * disclaimer in the documentation and/or other materials provided
018: * with the distribution.
019: *
020: * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
021: * names of its contributors may be used to endorse or promote
022: * products derived from this software without specific prior
023: * written permission.
024: *
025: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
026: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
027: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
028: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
029: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
030: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
031: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
032: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
033: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
034: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
035: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
036: ********************************************************************************/package net.sourceforge.cruisecontrol;
037:
038: import java.util.Calendar;
039: import java.util.Date;
040: import java.util.Map;
041:
042: import net.sourceforge.cruisecontrol.util.PerDayScheduleItem;
043: import net.sourceforge.cruisecontrol.util.ValidationHelper;
044:
045: import org.jdom.Element;
046:
047: public abstract class Builder extends PerDayScheduleItem implements
048: Comparable {
049:
050: private int time = NOT_SET;
051: private int multiple = 1;
052: private boolean multipleSet = false;
053: private String group = "default";
054: private boolean showProgress = true;
055:
056: /**
057: * Execute a build.
058: * @param properties build properties
059: * @param progress callback to provide progress updates
060: * @return the log resulting from executing the build
061: * @throws CruiseControlException if something breaks
062: */
063: public abstract Element build(Map properties, Progress progress)
064: throws CruiseControlException;
065:
066: /**
067: * Execute a build with the given target.
068: * @param properties build properties
069: * @param target the build target to call, overrides target defined in config
070: * @param progress callback to provide progress updates
071: * @return the log resulting from executing the build
072: * @throws CruiseControlException if something breaks
073: */
074: public abstract Element buildWithTarget(Map properties,
075: String target, Progress progress)
076: throws CruiseControlException;
077:
078: public void validate() throws CruiseControlException {
079: boolean timeSet = time != NOT_SET;
080:
081: ValidationHelper
082: .assertFalse(timeSet && multipleSet,
083: "Only one of 'time' or 'multiple' are allowed on builders.");
084: }
085:
086: public int getTime() {
087: return time;
088: }
089:
090: /**
091: * can use ScheduleItem.NOT_SET to reset.
092: * @param timeString new time integer
093: */
094: public void setTime(String timeString) {
095: time = Integer.parseInt(timeString);
096: }
097:
098: /**
099: * can use Builder.NOT_SET to reset.
100: * @param multiple new multiple
101: */
102: public void setMultiple(int multiple) {
103: multipleSet = multiple != NOT_SET;
104: this .multiple = multiple;
105: }
106:
107: public int getMultiple() {
108: boolean timeSet = time != NOT_SET;
109: if (timeSet && !multipleSet) {
110: return NOT_SET;
111: }
112: return multiple;
113: }
114:
115: public String getGroup() {
116: return group;
117: }
118:
119: public void setGroup(String group) {
120: this .group = group;
121: }
122:
123: public void setShowProgress(final boolean showProgress) {
124: this .showProgress = showProgress;
125: }
126:
127: public boolean getShowProgress() {
128: return showProgress;
129: }
130:
131: /**
132: * Is this the correct day to be running this builder?
133: * @param now the current date
134: * @return true if this this the correct day to be running this builder
135: */
136: public boolean isValidDay(Date now) {
137: if (getDay() < 0) {
138: return true;
139: }
140:
141: Calendar cal = Calendar.getInstance();
142: cal.setTime(now);
143: return cal.get(Calendar.DAY_OF_WEEK) == getDay();
144: }
145:
146: /**
147: * used to sort builders. we're only going to care about sorting builders based on build number,
148: * so we'll sort based on the multiple attribute.
149: */
150: public int compareTo(Object o) {
151: Builder builder = (Builder) o;
152: Integer integer = new Integer(multiple);
153: Integer integer2 = new Integer(builder.getMultiple());
154: return integer2.compareTo(integer); //descending order
155: }
156:
157: }
|