Package hudson.matrix

Class MatrixBuild

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Actionable

hudson.model.Run<P,R>

hudson.model.AbstractBuild<MatrixProject,MatrixBuild>

hudson.matrix.MatrixBuild

All Implemented Interfaces:

ExtensionPoint, DescriptorByNameOwner, ModelObject, PersistenceRoot, Queue.Executable, Saveable, SearchableModelObject, SearchItem, AccessControlled, Comparable<MatrixBuild>, Runnable, WithConsoleUrl, HistoricalBuild, LazyBuildMixIn.LazyLoadingRun<MatrixProject,MatrixBuild>, ModelObjectWithContextMenu, RunWithSCM<MatrixProject,MatrixBuild>, OnMaster, org.kohsuke.stapler.StaplerProxy

public class MatrixBuild
extends AbstractBuild<MatrixProject,MatrixBuild>

Build of MatrixProject.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MatrixBuild.MatrixBuildExecution	Object that lives from the start of MatrixBuild execution to its end.
final class	MatrixBuild.RunPtr	Used by view to render a ball for MatrixRun.

Nested classes/interfaces inherited from class hudson.model.AbstractBuild

AbstractBuild.AbstractBuildExecution, AbstractBuild.AbstractRunner, AbstractBuild.DependencyChange

Nested classes/interfaces inherited from class hudson.model.Run

Run.Artifact, Run.ArtifactList, Run.KeepLogBuildBadge, Run.RedirectUp, Run.RunExecution, Run.Runner, Run.RunnerAbortedException, Run.StatusSummarizer, Run.Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu

ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType

Field Summary

Fields inherited from class hudson.model.AbstractBuild

buildEnvironments

Fields inherited from class hudson.model.Run

ARTIFACTS, charset, DELETE, description, duration, FEED_ADAPTER, FEED_ADAPTER_LATEST, LIST_CUTOFF, nextBuild, number, ORDER_BY_DATE, PERMISSIONS, previousBuild, project, QUEUE_ID_UNKNOWN, result, SKIP_PERMISSION_CHECK, timestamp, UPDATE, XSTREAM, XSTREAM2

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
MatrixBuild(MatrixProject job)
MatrixBuild(MatrixProject project, File buildDir)
MatrixBuild(MatrixProject job, Calendar timestamp)

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete build and its child builds.
void	doDoDeleteAll(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Deprecated. kept not to break REST clients.
MatrixBuild	getBaseBuild()	Returns the base MatrixBuild that this build originates from.
String	getDeleteMessage()	Simple extension to AbstractBuild.getWhyKeepLog() required in order to have a warning which does not prevent the actual deletion.
Fingerprint.RangeSet	getDownstreamRelationship(AbstractProject that)
Object	getDynamic(String token, org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
MatrixRun	getExactRun(Combination c)	Like getRun(Combination), but do not approximate the result by earlier execution of the given combination (which is done for partial rebuild of the matrix.)
List<MatrixRun>	getExactRuns()	Returns all MatrixRuns for exactly this MatrixBuild.
Layouter<MatrixBuild.RunPtr>	getLayouter()
MatrixRun	getRun(Combination c)	Gets the MatrixRun in this build that corresponds to the given combination.
List<MatrixRun>	getRuns()	Returns all MatrixRuns for this MatrixBuild.
boolean	isLinkedBy(MatrixBuild b)
boolean	isPartial()	True if this build didn't do a full build and it is depending on the result of the previous build.
Object	readResolve()
void	run()
void	setBaseBuild(MatrixBuild baseBuild)	Sets the base build from which this build is derived.

Methods inherited from class hudson.model.AbstractBuild

addAction, calculateCulprits, createReference, doStop, doStop, dropLinks, due, getAggregatedTestResultAction, getBuildVariableResolver, getBuildVariables, getBuiltOn, getBuiltOnStr, getChangeSet, getChangeSets, getCulpritIds, getCulprits, getDependencyChanges, getDownstreamBuilds, getDownstreamBuilds, getEnvironment, getEnvironments, getHudsonVersion, getModuleRoot, getModuleRoots, getNextBuild, getParentExecutable, getPersistentActions, getPreviousBuild, getProject, getRootBuild, getRunMixIn, getSensitiveBuildVariables, getTestResultAction, getTransitiveUpstreamBuilds, getUpstreamBuilds, getUpstreamRelationship, getUpstreamRelationshipBuild, getUpUrl, getWhyKeepLog, getWorkspace, hasChangeSetComputed, setBuiltOnStr, setWorkspace, shouldCalculateCulprits

Methods inherited from class hudson.model.Run

_this, canToggleLogKeep, compareTo, deleteArtifacts, doArtifact, doBuildNumber, doBuildStatus, doBuildTimestamp, doConfigSubmit, doConsoleText, doConsoleText, doDoDelete, doDoDelete, doProgressiveLog, doSubmitDescription, doToggleLogKeep, execute, fromExternalizableId, getAbsoluteUrl, getACL, getApi, getArtifactManager, getArtifacts, getArtifactsDir, getArtifactsUpTo, getBadgeActions, getBuildFingerprints, getBuildsOverThreshold, getBuildStatusSummary, getCause, getCauses, getCharacteristicEnvVars, getCharset, getConsoleUrl, getDescription, getDisplayName, getDuration, getDurationString, getDynamic, getEnvironment, getEnvVars, getEstimatedDuration, getExecutor, getExternalizableId, getFullDisplayName, getHasArtifacts, getIconColor, getId, getLog, getLog, getLogFile, getLogInputStream, getLogReader, getLogText, getNumber, getOneOffExecutor, getParameterValues, getParent, getPreviousBuildInProgress, getPreviousBuildsOverThreshold, getPreviousBuiltBuild, getPreviousCompletedBuild, getPreviousFailedBuild, getPreviousNotFailedBuild, getPreviousSuccessfulBuild, getQueueId, getResult, getRootDir, getSearchUrl, getStartTimeInMillis, getTarget, getTime, getTimeInMillis, getTimestamp, getTimestampString, getTimestampString2, getTransientActions, getUrl, hasCustomDisplayName, hasntStartedYet, isBuilding, isInProgress, isKeepLog, isLogUpdated, keepLog, keepLog, makeSearchIndex, onEndBuilding, onLoad, onStartBuilding, pickArtifactManager, reload, run, save, setDescription, setDisplayName, setQueueId, setResult, submit, toString, updateSymlinks, writeLogTo, writeReplace, writeWholeLogTo

Methods inherited from class hudson.model.Actionable

addOrReplaceAction, doContextMenu, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, removeAction, removeActions, replaceAction, replaceActions

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface hudson.security.AccessControlled

checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2

Methods inherited from interface hudson.model.DescriptorByNameOwner

getDescriptorByName

Methods inherited from interface jenkins.model.HistoricalBuild

getBuildStatusIconClassName, getBuildStatusUrl, getTruncatedDescription

Methods inherited from interface hudson.model.Queue.Executable

getConsoleUrl, getEstimatedDuration, getParent, toString

Methods inherited from interface jenkins.scm.RunWithSCM

hasParticipant

Constructor Details

MatrixBuild

public MatrixBuild(MatrixProject job)
            throws IOException

Throws:

IOException

MatrixBuild

public MatrixBuild(MatrixProject job,
 Calendar timestamp)

MatrixBuild

public MatrixBuild(MatrixProject project,
 File buildDir)
            throws IOException

Throws:

IOException

Method Details

readResolve

public Object readResolve()

delete

public void delete()
            throws IOException

Delete build and its child builds.

Overrides:

delete in class Run<MatrixProject,MatrixBuild>

Throws:

IOException

Since:

TODO

doDoDeleteAll

@Deprecated
public void doDoDeleteAll(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                   throws IOException,
jakarta.servlet.ServletException

Deprecated.

kept not to break REST clients.

Deletes the build and all matrix configurations in this build when the button is pressed.

Throws:

IOException

jakarta.servlet.ServletException

getLayouter

public Layouter<MatrixBuild.RunPtr> getLayouter()

setBaseBuild

public void setBaseBuild(MatrixBuild baseBuild)

Sets the base build from which this build is derived.

Since:

1.416

getBaseBuild

public MatrixBuild getBaseBuild()

Returns the base MatrixBuild that this build originates from.

If this build is a partial build, unexecuted MatrixRuns are delegated to this build number.

getRun

public MatrixRun getRun(Combination c)

Gets the MatrixRun in this build that corresponds to the given combination.

getExactRun

public MatrixRun getExactRun(Combination c)

Like getRun(Combination), but do not approximate the result by earlier execution of the given combination (which is done for partial rebuild of the matrix.)

getRuns

@Exported
public List<MatrixRun> getRuns()

Returns all MatrixRuns for this MatrixBuild.

getExactRuns

public List<MatrixRun> getExactRuns()

Returns all MatrixRuns for exactly this MatrixBuild.

Unlike getRuns(), this method excludes those runs that didn't run and got inherited.

Since:

1.413

getDeleteMessage

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getDeleteMessage()

Simple extension to AbstractBuild.getWhyKeepLog() required in order to have a warning which does not prevent the actual deletion.

Returns:

message displayed deleting build

isLinkedBy

public boolean isLinkedBy(MatrixBuild b)

Returns:

True if another MatrixBuild build (passed as a parameter) depends on this build.

Since:

1.481

isPartial

public boolean isPartial()

True if this build didn't do a full build and it is depending on the result of the previous build.

getDynamic

public Object getDynamic(String token,
 org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)

Overrides:

getDynamic in class Run<MatrixProject,MatrixBuild>

run

public void run()

Specified by:

run in interface Queue.Executable

Specified by:

run in interface Runnable

Specified by:

run in class AbstractBuild<MatrixProject,MatrixBuild>

getDownstreamRelationship

public Fingerprint.RangeSet getDownstreamRelationship(AbstractProject that)

Overrides:

getDownstreamRelationship in class AbstractBuild<MatrixProject,MatrixBuild>