Project.java

Index Score
net.sourceforge.cruisecontrol
CruiseControl

View: Reasons, Metrics, Source Code

These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.

MetricDescription
EXITSProcedure exits
RETURNSNumber of return points from functions
BLOCKSNumber of blocks
FUNCTIONSNumber of function declarations
JAVA0117JAVA0117 Missing javadoc: method 'method'
CYCLOMATICCyclomatic complexity
SIZESize of the file in bytes
INTERFACE_COMPLEXITYInterface complexity
LOGICAL_LINESNumber of statements
UNIQUE_OPERANDSNumber of unique operands
LOCLines of code
ELOCEffective lines of code
OPERATORSNumber of operators
PROGRAM_VOCABHalstead program vocabulary
PROGRAM_LENGTHHalstead program length
LINESNumber of lines in the source file
OPERANDSNumber of operands
JAVA0254JAVA0254 Use enhanced for loop construct instead of Iterator
LINE_COMMENTNumber of line comments
JAVA0233JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0034JAVA0034 Missing braces in if statement
COMPARISONSNumber of comparison operators
EXEC_COMMENTSComments in executable code
PARAMSNumber of formal parameter declarations
JAVA0240JAVA0240 Serializable class which declares readObject or writeObject but not both
WHITESPACENumber of whitespace lines
JAVA0130JAVA0130 Non-static method does not use instance fields
LOOPSNumber of loops
UNIQUE_OPERATORSNumber of unique operators
JAVA0166JAVA0166 Generic exception caught
NEST_DEPTHMaximum nesting depth
DOC_COMMENTNumber of javadoc comment lines
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0160JAVA0160 Method does not throw specified exception
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0087JAVA0087 Use of Thread.sleep()
DECL_COMMENTSComments in declarations
JAVA0100JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0075JAVA0075 Method parameter hides field
COMMENTSComment lines
JAVA0145JAVA0145 Tab character used in source file
/******************************************************************************** * CruiseControl, a Continuous Integration Toolkit * Copyright (c) 2001-2003, 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.io.FileOutputStream; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import javax.management.JMException; import javax.management.MBeanServer; import net.sourceforge.cruisecontrol.events.BuildProgressEvent; import net.sourceforge.cruisecontrol.events.BuildProgressListener; import net.sourceforge.cruisecontrol.events.BuildResultEvent; import net.sourceforge.cruisecontrol.events.BuildResultListener; import net.sourceforge.cruisecontrol.jmx.ProjectController; import net.sourceforge.cruisecontrol.listeners.ProjectStateChangedEvent; import net.sourceforge.cruisecontrol.util.CVSDateUtil; import net.sourceforge.cruisecontrol.util.DateUtil; import net.sourceforge.cruisecontrol.util.IO; import org.apache.log4j.Logger; import org.jdom.Element; /** * Represents a single logical project consisting of source code that needs to * be built. Project is associated with bootstrappers that run before builds * and a Schedule that determines when builds occur. */ public class Project implements Serializable, Runnable { static final long serialVersionUID = 2656877748476842326L; private static final Logger LOG = Logger.getLogger(Project.class); private transient ProjectState state; private transient ProjectConfig projectConfig; private transient LabelIncrementer labelIncrementer; /** * If this attribute is set, then it means that the user has overridden * the build interval specified in the Schedule element, probably * using the JMX interface. */ private transient Long overrideBuildInterval; private transient Date buildStartTime; private transient Object pausedMutex; private transient Object scheduleMutex; private transient Object waitMutex; private transient BuildQueue queue; private transient List progressListeners; private transient List resultListeners; private transient Progress progress; private int buildCounter = 0; private Date lastBuild = DateUtil.getMidnight(); private Date lastSuccessfulBuild = lastBuild; private boolean wasLastBuildSuccessful = true; private String label; private String name; private transient boolean buildForced = false; private String buildTarget = null; private boolean isPaused = false; private boolean buildAfterFailed = true; private boolean stopped = true; private boolean forceOnly = false; private boolean requiremodification = true; public Project() { initializeTransientFields(); } private void initializeTransientFields() { state = ProjectState.STOPPED; pausedMutex = new Object(); scheduleMutex = new Object(); waitMutex = new Object(); progressListeners = new ArrayList(); resultListeners = new ArrayList(); progress = new ProgressImpl(this); } private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException { stream.defaultReadObject(); initializeTransientFields(); } public void execute() { if (stopped) { LOG.warn("not building project " + name + " because project has been stopped."); buildFinished(); return; } synchronized (pausedMutex) { if (isPaused) { LOG.info("not building project " + name + " because project has been paused."); buildFinished(); return; } } try { init(); build(); } catch (CruiseControlException e) { LOG.error("exception attempting build in project " + name, e); } finally { buildFinished(); } } /** * Unless paused, runs any bootstrappers and then the entire build. * @throws CruiseControlException if an error occurs during the build */ protected void build() throws CruiseControlException { if (projectConfig == null) { throw new IllegalStateException("projectConfig must be set on project before calling build()"); } if (stopped) { LOG.warn("not building project " + name + " because project has been stopped."); return; } // If the force only flag is set, only build if forced // or if the last build faild and we want to build on failures if (forceOnly && !buildForced && !(!wasLastBuildSuccessful && buildAfterFailed)) { info("not building because project is forceOnly and build not forced."); return; } boolean buildWasForced = buildForced; try { setBuildStartTime(new Date()); Schedule schedule = projectConfig.getSchedule(); if (schedule == null) { throw new IllegalStateException("project must have a schedule"); } if (schedule.isPaused(buildStartTime)) { // a regularly scheduled paused // is different than ProjectState.PAUSED return; } // @todo Add Progress param to Bootstrapper API? bootstrap(); String target = useAndResetBuildTargetIfBuildWasForced(buildWasForced); // @todo Add Progress param to ModificationSet API? // getModifications will only return null if we don't need to build Element modifications = getModifications(buildWasForced); if (modifications == null) { return; } // Using local reference to avoid NPE if config.xml is updated during build Log buildLog = projectConfig.getLog(); buildLog.addContent(modifications); Date now = new Date(); if (projectConfig.getModificationSet() != null && projectConfig.getModificationSet().getTimeOfCheck() != null) { now = projectConfig.getModificationSet().getTimeOfCheck(); } if (getLabelIncrementer().isPreBuildIncrementer()) { label = getLabelIncrementer().incrementLabel(label, buildLog.getContent()); } // collect project information buildLog.addContent(getProjectPropertiesElement(now)); setState(ProjectState.BUILDING); Element builderLog = schedule.build(buildCounter, lastBuild, now, getProjectPropertiesMap(now), target, progress); buildLog.addContent(builderLog.detach()); boolean buildSuccessful = buildLog.wasBuildSuccessful(); fireResultEvent(new BuildResultEvent(this, buildSuccessful)); if (!getLabelIncrementer().isPreBuildIncrementer() && buildSuccessful) { label = getLabelIncrementer().incrementLabel(label, buildLog.getContent()); } setState(ProjectState.MERGING_LOGS); buildLog.writeLogFile(now); // If we only want to build after a check in, even when broken, set the last build to now, // regardless of success or failure (buildAfterFailed = false in config.xml) if (!buildAfterFailed) { lastBuild = now; } // If this was a successful build, update both last build and last successful build if (buildSuccessful) { lastBuild = now; lastSuccessfulBuild = now; info("build successful"); } else { info("build failed"); } buildCounter++; setWasLastBuildSuccessful(buildSuccessful); // also need to reset forced flag before serializing, unless buildForced var is transient //resetBuildForcedOnlyIfBuildWasForced(buildWasForced); serializeProject(); // @todo Add Progress param to Publisher API? publish(buildLog); buildLog.reset(); } finally { resetBuildForcedOnlyIfBuildWasForced(buildWasForced); setState(ProjectState.IDLE); } } private String useAndResetBuildTargetIfBuildWasForced(boolean buildWasForced) { String target = null; if (buildWasForced) { target = buildTarget; buildTarget = null; } return target; } private void resetBuildForcedOnlyIfBuildWasForced(boolean buildWasForced) { if (buildWasForced) { buildForced = false; } } void setBuildStartTime(Date date) { buildStartTime = date; } public void run() { LOG.info("Project " + name + " started"); try { while (!stopped) { try { waitIfPaused(); if (!stopped) { waitForNextBuild(); } if (!stopped) { setState(ProjectState.QUEUED); synchronized (scheduleMutex) { queue.requestBuild(projectConfig); waitForBuildToFinish(); } } } catch (InterruptedException e) { String message = "Project " + name + ".run() interrupted"; LOG.error(message, e); throw new RuntimeException(message); } } } finally { stopped = true; LOG.info("Project " + name + " stopped"); } } void waitIfPaused() throws InterruptedException { synchronized (pausedMutex) { while (isPaused) { setState(ProjectState.PAUSED); pausedMutex.wait(10 * DateUtil.ONE_MINUTE); } } } void waitForNextBuild() throws InterruptedException { long waitTime = getTimeToNextBuild(new Date()); if (needToWaitForNextBuild(waitTime) && !buildForced) { final String msg = "next build in " + DateUtil.formatTime(waitTime); info(msg); synchronized (waitMutex) { setState(ProjectState.WAITING); progress.setValue(msg); waitMutex.wait(waitTime); } } } long getTimeToNextBuild(Date now) { long waitTime = projectConfig.getSchedule().getTimeToNextBuild(now, getBuildInterval()); if (waitTime == 0) { // check for the exceptional case that we're dealing with a // project that has just built within a minute time if (buildStartTime != null) { long millisSinceLastBuild = now.getTime() - buildStartTime.getTime(); if (millisSinceLastBuild < Schedule.ONE_MINUTE) { debug("build finished within a minute, getting new time to next build"); Date oneMinuteInFuture = new Date(now.getTime() + Schedule.ONE_MINUTE); waitTime = projectConfig.getSchedule().getTimeToNextBuild(oneMinuteInFuture, getBuildInterval()); waitTime += Schedule.ONE_MINUTE; } } } return waitTime; } static boolean needToWaitForNextBuild(long waitTime) { return waitTime > 0; } /** @return true if build was forced, intended for unit testing only. */ boolean isBuildForced() { return buildForced; } void forceBuild() { synchronized (waitMutex) { waitMutex.notify(); } } public void forceBuildWithTarget(String buildTarget) { this.buildTarget = buildTarget; setBuildForced(true); } void waitForBuildToFinish() throws InterruptedException { synchronized (scheduleMutex) { debug("waiting for build to finish"); scheduleMutex.wait(); } } void buildFinished() { synchronized (scheduleMutex) { debug("build finished"); scheduleMutex.notify(); } } /** * Return modifications since the last build. timeOfCheck will be updated according to the last modification to * account for time synchronisation issues. * * @param buildWasForced true if the build was forced * @return Element jdom element containing modification information */ Element getModifications(final boolean buildWasForced) { setState(ProjectState.MODIFICATIONSET); Element modifications; ModificationSet modificationSet = projectConfig.getModificationSet(); if (modificationSet == null) { debug("no modification set, nothing to detect."); if (buildWasForced) { info("no modification set but build was forced"); return new Element("modifications"); } if (!requiremodification) { info("no modification set but no modifications required"); return new Element("modifications"); } return null; } boolean checkNewChangesFirst = checkOnlySinceLastBuild(); if (checkNewChangesFirst) { debug("getting changes since last build"); modifications = modificationSet.retrieveModificationsAsElement(lastBuild, progress); } else { debug("getting changes since last successful build"); modifications = modificationSet.retrieveModificationsAsElement(lastSuccessfulBuild, progress); } if (!modificationSet.isModified()) { info("No modifications found, build not necessary."); // Sometimes we want to build even though we don't have any // modifications: // * last build failed & buildaferfailed="true" // * requiremodifications="false" // * build forced if (buildAfterFailed && !wasLastBuildSuccessful) { info("Building anyway, since buildAfterFailed is true and last build failed."); } else if (!requiremodification) { info("Building anyway, since modifications not required"); } else { if (buildWasForced) { info("Building anyway, since build was explicitly forced."); } else { return null; } } } if (checkNewChangesFirst) { debug("new changes found; now getting complete set"); modifications = modificationSet.retrieveModificationsAsElement(lastSuccessfulBuild, progress); } return modifications; } /** * @return boolean */ boolean checkOnlySinceLastBuild() { if (lastBuild == null || lastSuccessfulBuild == null) { return false; } long lastBuildLong = lastBuild.getTime(); long timeDifference = lastBuildLong - lastSuccessfulBuild.getTime(); boolean moreThanASecond = timeDifference > DateUtil.ONE_SECOND; return !buildAfterFailed && moreThanASecond; } /** * Serialize the project to allow resumption after a process bounce */ public void serializeProject() { ObjectOutputStream s = null; try { s = new ObjectOutputStream(new FileOutputStream(name + ".ser")); s.writeObject(this); s.flush(); debug("Serializing project to [" + name + ".ser]"); } catch (Exception e) { LOG.warn("Error serializing project to [" + name + ".ser]: " + e.getMessage(), e); } finally { IO.close(s); } } public void setLabelIncrementer(LabelIncrementer incrementer) throws CruiseControlException { if (incrementer == null) { throw new IllegalArgumentException("label incrementer can't be null"); } labelIncrementer = incrementer; if (label == null) { label = labelIncrementer.getDefaultLabel(); } validateLabel(label, labelIncrementer); } public LabelIncrementer getLabelIncrementer() { return labelIncrementer; } public void setName(String projectName) { name = projectName; } public String getName() { return name; } public void setLabel(String newLabel) { label = newLabel; } public String getLabel() { return label; } /** * @param newLastBuild string containing the build date in the format * yyyyMMddHHmmss * @throws CruiseControlException if the date cannot be extracted from the * input string */ public void setLastBuild(String newLastBuild) throws CruiseControlException { lastBuild = DateUtil.parseFormattedTime(newLastBuild, "lastBuild"); } /** * @param newLastSuccessfulBuild string containing the build date in the format * yyyyMMddHHmmss * @throws CruiseControlException if the date cannot be extracted from the * input string */ public void setLastSuccessfulBuild(String newLastSuccessfulBuild) throws CruiseControlException { lastSuccessfulBuild = DateUtil.parseFormattedTime(newLastSuccessfulBuild, "lastSuccessfulBuild"); } public String getLastBuild() { if (lastBuild == null) { return null; } return DateUtil.getFormattedTime(lastBuild); } public boolean getBuildForced() { return buildForced; } public void setBuildForced(boolean forceNewBuildNow) { buildForced = forceNewBuildNow; if (forceNewBuildNow) { forceBuild(); } } public String getLastSuccessfulBuild() { if (lastSuccessfulBuild == null) { return null; } return DateUtil.getFormattedTime(lastSuccessfulBuild); } public String getLogDir() { return projectConfig.getLog().getLogDir(); } /** * Returns the build interval. This value is initially specified on the * schedule, but the user may override that value using the JMX interface. * If the user hasn't override the Schedule, then this method will * return the Schedule's interval, otherwise the overridden value will * be returned. * @return the build interval */ public long getBuildInterval() { if (overrideBuildInterval == null) { return projectConfig.getSchedule().getInterval(); } else { return overrideBuildInterval.longValue(); } } /** * Sets the build interval that this Project should use. This method * overrides the value initially specified in the Schedule attribute. * @param sleepMillis the number of milliseconds to sleep between build attempts */ public void overrideBuildInterval(long sleepMillis) { overrideBuildInterval = new Long(sleepMillis); } public boolean isPaused() { return isPaused; } public void setPaused(boolean paused) { synchronized (pausedMutex) { if (isPaused && !paused) { pausedMutex.notifyAll(); } isPaused = paused; } } public void setBuildAfterFailed(boolean rebuildEvenWithNoNewModifications) { buildAfterFailed = rebuildEvenWithNoNewModifications; } public String getStatus() { return getState().getDescription(); } public String getStatusWithQueuePosition() { if (ProjectState.QUEUED.equals(getState())) { return getState().getDescription() + " - " + queue.findPosition(projectConfig); } else { return getState().getDescription(); } } public ProjectState getState() { return state; } private void setState(ProjectState newState) { state = newState; info(getStatus()); notifyListeners(new ProjectStateChangedEvent(name, getState())); fireProgressEvent(new BuildProgressEvent(this, getState())); } public void setBuildQueue(BuildQueue buildQueue) { queue = buildQueue; } public String getBuildStartTime() { return DateUtil.getFormattedTime(buildStartTime); } public Log getLog() { return this.projectConfig.getLog(); } /** * Initialize the project. Uses ProjectXMLHelper to parse a project file. */ protected void init() { if (projectConfig == null) { throw new IllegalStateException("projectConfig must be set on project before calling init()"); } buildAfterFailed = projectConfig.shouldBuildAfterFailed(); forceOnly = projectConfig.isForceOnly(); requiremodification = projectConfig.isRequiremodification(); if (lastBuild == null) { lastBuild = DateUtil.getMidnight(); } if (lastSuccessfulBuild == null) { lastSuccessfulBuild = lastBuild; } // should we move this to build? This singleton thingy is scaring me.. setDateFormat(projectConfig.getDateFormat()); if (LOG.isDebugEnabled()) { debug("buildInterval = [" + getBuildInterval() + "]"); debug("buildForced = [" + buildForced + "]"); debug("buildAfterFailed = [" + buildAfterFailed + "]"); debug("requireModifcation = [" + requiremodification + "]"); debug("forceOnly = [" + forceOnly + "]"); debug("buildCounter = [" + buildCounter + "]"); debug("isPaused = [" + isPaused + "]"); debug("label = [" + label + "]"); debug("lastBuild = [" + DateUtil.getFormattedTime(lastBuild) + "]"); debug("lastSuccessfulBuild = [" + DateUtil.getFormattedTime(lastSuccessfulBuild) + "]"); debug("logDir = [" + projectConfig.getLog().getLogDir() + "]"); debug("logXmlEncoding = [" + projectConfig.getLog().getLogXmlEncoding() + "]"); debug("wasLastBuildSuccessful = [" + wasLastBuildSuccessful + "]"); } } private void setDateFormat(CCDateFormat dateFormat) { if (dateFormat != null && dateFormat.getFormat() != null) { DateFormatFactory.setFormat(dateFormat.getFormat()); } } protected Element getProjectPropertiesElement(Date now) { Element infoElement = new Element("info"); addProperty(infoElement, "projectname", name); String lastBuildString = DateUtil.getFormattedTime(lastBuild == null ? now : lastBuild); addProperty(infoElement, "lastbuild", lastBuildString); String lastSuccessfulBuildString = DateUtil.getFormattedTime(lastSuccessfulBuild == null ? now : lastSuccessfulBuild); addProperty(infoElement, "lastsuccessfulbuild", lastSuccessfulBuildString); addProperty(infoElement, "builddate", DateFormatFactory.getDateFormat().format(now)); addProperty(infoElement, "cctimestamp", DateUtil.getFormattedTime(now)); addProperty(infoElement, "label", label); addProperty(infoElement, "interval", Long.toString(getBuildInterval() / 1000L)); addProperty(infoElement, "lastbuildsuccessful", String.valueOf(wasLastBuildSuccessful)); return infoElement; } private void addProperty(Element parent, String key, String value) { Element propertyElement = new Element("property"); propertyElement.setAttribute("name", key); propertyElement.setAttribute("value", value); parent.addContent(propertyElement); } protected Map getProjectPropertiesMap(Date now) { Map buildProperties = new HashMap(); buildProperties.put("projectname", name); buildProperties.put("label", label); // TODO: Shouldn't have CVS specific properties here buildProperties.put("cvstimestamp", CVSDateUtil.formatCVSDate(now)); buildProperties.put("cctimestamp", DateUtil.getFormattedTime(now)); buildProperties.put("cclastgoodbuildtimestamp", getLastSuccessfulBuild()); buildProperties.put("cclastbuildtimestamp", getLastBuild()); buildProperties.put("lastbuildsuccessful", String.valueOf(isLastBuildSuccessful())); buildProperties.put("buildforced", String.valueOf(getBuildForced())); if (projectConfig.getModificationSet() != null) { buildProperties.putAll(projectConfig.getModificationSet().getProperties()); } return buildProperties; } /** * Iterate over all of the registered <code>Publisher</code>s and call * their respective <code>publish</code> methods. * @param buildLog the content to publish * @throws CruiseControlException if an error occurs during publishing */ protected void publish(Log buildLog) throws CruiseControlException { setState(ProjectState.PUBLISHING); for (Iterator i = projectConfig.getPublishers().iterator(); i.hasNext(); ) { Publisher publisher = (Publisher) i.next(); // catch all errors, Publishers shouldn't cause failures in the build method try { publisher.publish(buildLog.getContent()); } catch (Throwable t) { StringBuffer message = new StringBuffer("exception publishing results"); message.append(" with ").append(publisher.getClass().getName()); message.append(" for project ").append(name); LOG.error(message.toString(), t); } } } /** * Iterate over all of the registered <code>Bootstrapper</code>s and call * their respective <code>bootstrap</code> methods. * @throws CruiseControlException if an error occurs during bootstrapping */ protected void bootstrap() throws CruiseControlException { setState(ProjectState.BOOTSTRAPPING); for (Iterator i = projectConfig.getBootstrappers().iterator(); i.hasNext(); ) { ((Bootstrapper) i.next()).bootstrap(); } } /** * Ensure that label is valid for the specified LabelIncrementer * * @param oldLabel target label * @param incrementer target LabelIncrementer * @throws CruiseControlException if label is not valid */ protected void validateLabel(String oldLabel, LabelIncrementer incrementer) throws CruiseControlException { if (!incrementer.isValidLabel(oldLabel)) { final String message = oldLabel + " is not a valid label for labelIncrementer " + incrementer.getClass().getName(); debug(message); throw new CruiseControlException(message); } } public boolean isLastBuildSuccessful() { return wasLastBuildSuccessful; } void setWasLastBuildSuccessful(boolean buildSuccessful) { wasLastBuildSuccessful = buildSuccessful; } /** * Logs a message to the application log, not to be confused with the * CruiseControl build log. * @param message the application message to log */ private void info(String message) { LOG.info("Project " + name + ": " + message); } private void debug(String message) { LOG.debug("Project " + name + ": " + message); } public void start() { if (stopped || getState() == ProjectState.STOPPED) { stopped = false; LOG.info("Project " + name + " starting"); setState(ProjectState.IDLE); createNewSchedulingThread(); } } protected void createNewSchedulingThread() { Thread projectSchedulingThread = new Thread(this, "Project " + getName() + " thread"); projectSchedulingThread.start(); // brief nap to allow thread to start try { Thread.sleep(100); } catch (InterruptedException ie) { LOG.warn("interrupted while waiting for scheduling thread to start", ie); } } public void stop() { LOG.info("Project " + name + " stopping"); stopped = true; setState(ProjectState.STOPPED); synchronized (pausedMutex) { pausedMutex.notifyAll(); } synchronized (waitMutex) { waitMutex.notifyAll(); } synchronized (scheduleMutex) { scheduleMutex.notifyAll(); } } public String toString() { StringBuffer sb = new StringBuffer("Project "); sb.append(getName()); sb.append(": "); sb.append(getStatus()); if (isPaused) { sb.append(" (paused)"); } return sb.toString(); } public void addBuildProgressListener(BuildProgressListener listener) { synchronized (progressListeners) { progressListeners.add(listener); } } protected void fireProgressEvent(BuildProgressEvent event) { synchronized (progressListeners) { for (Iterator i = progressListeners.iterator(); i.hasNext();) { BuildProgressListener listener = (BuildProgressListener) i.next(); listener.handleBuildProgress(event); } } } public void addBuildResultListener(BuildResultListener listener) { synchronized (resultListeners) { resultListeners.add(listener); } } protected void fireResultEvent(BuildResultEvent event) { synchronized (resultListeners) { for (Iterator i = resultListeners.iterator(); i.hasNext();) { BuildResultListener listener = (BuildResultListener) i.next(); listener.handleBuildResult(event); } } } List getListeners() { return projectConfig.getListeners(); } public void setProjectConfig(ProjectConfig projectConfig) throws CruiseControlException { if (projectConfig == null) { throw new IllegalArgumentException("project config can't be null"); } this.projectConfig = projectConfig; setLabelIncrementer(projectConfig.getLabelIncrementer()); } void notifyListeners(ProjectEvent event) { if (projectConfig == null) { throw new IllegalStateException("projectConfig is null"); } for (Iterator i = projectConfig.getListeners().iterator(); i.hasNext();) { Listener listener = (Listener) i.next(); try { listener.handleEvent(event); } catch (CruiseControlException e) { StringBuffer message = new StringBuffer("exception notifying listener "); message.append(listener.getClass().getName()); message.append(" for project ").append(name); LOG.error(message.toString(), e); } } } public boolean equals(Object arg0) { if (arg0 == null) { return false; } if (arg0.getClass().getName().equals(getClass().getName())) { Project thatProject = (Project) arg0; return thatProject.name.equals(name); } return false; } public int hashCode() { return name.hashCode(); } public void register(MBeanServer server) throws JMException { LOG.debug("Registering project mbean"); ProjectController projectController = new ProjectController(this); projectController.register(server); } public ProjectConfig getProjectConfig() { return projectConfig; } public Date getLastBuildDate() { return lastBuild; } public Progress getProgress() { return progress; } }

The table below shows all metrics for Project.java.

MetricValueDescription
BLOCKS173.00Number of blocks
BLOCK_COMMENT 0.00Number of block comment lines
COMMENTS141.00Comment lines
COMMENT_DENSITY 0.27Comment density
COMPARISONS60.00Number of comparison operators
CYCLOMATIC153.00Cyclomatic complexity
DECL_COMMENTS17.00Comments in declarations
DOC_COMMENT115.00Number of javadoc comment lines
ELOC517.00Effective lines of code
EXEC_COMMENTS16.00Comments in executable code
EXITS137.00Procedure exits
FUNCTIONS75.00Number of function declarations
HALSTEAD_DIFFICULTY76.57Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY154.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 0.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 1.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 2.00JAVA0074 Use of Object.notify()
JAVA0075 1.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 1.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 1.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 0.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 0.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 1.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 1.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA011738.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 2.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 0.00JAVA0144 Line exceeds maximum M characters
JAVA0145 0.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 1.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 2.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 1.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 1.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 1.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 1.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 5.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES951.00Number of lines in the source file
LINE_COMMENT26.00Number of line comments
LOC674.00Lines of code
LOGICAL_LINES346.00Number of statements
LOOPS 7.00Number of loops
NEST_DEPTH 6.00Maximum nesting depth
OPERANDS1332.00Number of operands
OPERATORS2721.00Number of operators
PARAMS39.00Number of formal parameter declarations
PROGRAM_LENGTH4053.00Halstead program length
PROGRAM_VOCAB514.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS115.00Number of return points from functions
SIZE34124.00Size of the file in bytes
UNIQUE_OPERANDS461.00Number of unique operands
UNIQUE_OPERATORS53.00Number of unique operators
WHITESPACE136.00Number of whitespace lines