Package jenkins.model.lazy

Class LazyBuildMixIn<JobT extends Job<JobT,RunT> & Queue.Task & LazyBuildMixIn.LazyLoadingJob<JobT,RunT>,RunT extends Run<JobT,RunT> & LazyBuildMixIn.LazyLoadingRun<JobT,RunT>>

java.lang.Object

jenkins.model.lazy.LazyBuildMixIn<JobT,RunT>

public abstract class LazyBuildMixIn<JobT extends Job<JobT,RunT> & Queue.Task & LazyBuildMixIn.LazyLoadingJob<JobT,RunT>,RunT extends Run<JobT,RunT> & LazyBuildMixIn.LazyLoadingRun<JobT,RunT>>
extends Object

Makes it easier to use a lazy RunMap from a Job implementation. Provides method implementations for some abstract Job methods, as well as some methods which are not abstract but which you should override.

Should be kept in a transient field in the job.

Since:

1.556

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LazyBuildMixIn.ItemListenerImpl
static interface	LazyBuildMixIn.LazyLoadingJob<JobT extends Job<JobT,RunT> & Queue.Task & LazyBuildMixIn.LazyLoadingJob<JobT,RunT>,RunT extends Run<JobT,RunT> & LazyBuildMixIn.LazyLoadingRun<JobT,RunT>>	Marker for a Job which uses this mixin.
static interface	LazyBuildMixIn.LazyLoadingRun<JobT extends Job<JobT,RunT> & Queue.Task & LazyBuildMixIn.LazyLoadingJob<JobT,RunT>,RunT extends Run<JobT,RunT> & LazyBuildMixIn.LazyLoadingRun<JobT,RunT>>	Marker for a Run which uses this mixin.
static class	LazyBuildMixIn.RunMixIn<JobT extends Job<JobT,RunT> & Queue.Task & LazyBuildMixIn.LazyLoadingJob<JobT,RunT>,RunT extends Run<JobT,RunT> & LazyBuildMixIn.LazyLoadingRun<JobT,RunT>>	Accompanying helper for the run type.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LazyBuildMixIn()	Initializes this mixin.

Method Summary

Modifier and Type	Method	Description
final RunMap<RunT>	_getRuns()	Same as getRunMap() but suitable for Job._getRuns().
protected abstract JobT	asJob()
final HistoryWidget	createHistoryWidget()	Deprecated, for removal: This API element is subject to removal in a future version. Remove any code calling this method, history widget is now created via WidgetFactory implementation.
final RunT	getBuild(String id)	Suitable for Job.getBuild(java.lang.String).
final RunT	getBuildByNumber(int n)	Suitable for Job.getBuildByNumber(int).
protected abstract Class<RunT>	getBuildClass()	Type token for the build type.
List<RunT>	getEstimatedDurationCandidates()	Suitable for Job.getEstimatedDurationCandidates().
final RunT	getFirstBuild()	Suitable for Job.getFirstBuild().
final RunT	getLastBuild()	Suitable for Job.getLastBuild().
final RunT	getNearestBuild(int n)	Suitable for Job.getNearestBuild(int).
final RunT	getNearestOldBuild(int n)	Suitable for Job.getNearestOldBuild(int).
final RunMap<RunT>	getRunMap()	Gets the raw model.
RunT	loadBuild(File dir)	Loads an existing build record from disk.
final RunT	newBuild()	Creates a new build of this project for immediate execution.
final void	onCreatedFromScratch()	Something to be called from Job.onCreatedFromScratch().
void	onLoad(ItemGroup<? extends Item> parent, String name)	Something to be called from Job.onLoad(hudson.model.ItemGroup<? extends hudson.model.Item>, java.lang.String).
final void	removeRun(RunT run)	Suitable for Job.removeRun(RunT).

Methods inherited from class java.lang.Object

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

Constructor Details

LazyBuildMixIn

protected LazyBuildMixIn()

Initializes this mixin. Call this from a constructor and AbstractItem.onLoad(hudson.model.ItemGroup<? extends hudson.model.Item>, java.lang.String) to make sure it is always initialized.

Method Details

asJob

protected abstract JobT asJob()

getRunMap

@NonNull
public final RunMap<RunT> getRunMap()

Gets the raw model. Normally should not be called as such. Note that the initial value is replaced during onCreatedFromScratch() or onLoad(hudson.model.ItemGroup<? extends hudson.model.Item>, java.lang.String).

_getRuns

public final RunMap<RunT> _getRuns()

Same as getRunMap() but suitable for Job._getRuns().

onCreatedFromScratch

public final void onCreatedFromScratch()

Something to be called from Job.onCreatedFromScratch().

onLoad

public void onLoad(ItemGroup<? extends Item> parent,
 String name)
            throws IOException

Something to be called from Job.onLoad(hudson.model.ItemGroup<? extends hudson.model.Item>, java.lang.String).

Throws:

IOException

getBuildClass

protected abstract Class<RunT> getBuildClass()

Type token for the build type. The build class must have two constructors: one taking the project type (P); and one taking P, then File.

loadBuild

public RunT loadBuild(File dir)
               throws IOException

Loads an existing build record from disk. The default implementation just calls the (Job, File) constructor of getBuildClass(), which will call Run(Job, File).

Throws:

IOException

newBuild

public final RunT newBuild()
                    throws IOException

Creates a new build of this project for immediate execution. Calls the (Job) constructor of getBuildClass(), which will call Run(Job). Suitable for SubTask.createExecutable().

Throws:

IOException

removeRun

public final void removeRun(RunT run)

Suitable for Job.removeRun(RunT).

getBuild

public final RunT getBuild(String id)

Suitable for Job.getBuild(java.lang.String).

getBuildByNumber

public final RunT getBuildByNumber(int n)

Suitable for Job.getBuildByNumber(int).

getFirstBuild

public final RunT getFirstBuild()

Suitable for Job.getFirstBuild().

getLastBuild

@CheckForNull
public final RunT getLastBuild()

Suitable for Job.getLastBuild().

getNearestBuild

public final RunT getNearestBuild(int n)

Suitable for Job.getNearestBuild(int).

getNearestOldBuild

public final RunT getNearestOldBuild(int n)

Suitable for Job.getNearestOldBuild(int).

getEstimatedDurationCandidates

public List<RunT> getEstimatedDurationCandidates()

Suitable for Job.getEstimatedDurationCandidates().

Since:

2.407

createHistoryWidget

@Deprecated(forRemoval=true,
            since="2.459")
public final HistoryWidget createHistoryWidget()

Deprecated, for removal: This API element is subject to removal in a future version.

Remove any code calling this method, history widget is now created via WidgetFactory implementation.