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 and Description
static 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>>
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 and Description
protected	LazyBuildMixIn() Initializes this mixin.

Method Summary

Modifier and Type	Method and Description
RunMap<RunT>	_getRuns() Same as getRunMap() but suitable for Job._getRuns().
protected abstract JobT	asJob()
HistoryWidget	createHistoryWidget() Suitable for Job.createHistoryWidget().
RunT	getBuild(String id) Suitable for Job.getBuild(java.lang.String).
RunT	getBuildByNumber(int n) Suitable for Job.getBuildByNumber(int).
protected abstract Class<RunT>	getBuildClass() Type token for the build type.
RunT	getFirstBuild() Suitable for Job.getFirstBuild().
RunT	getLastBuild() Suitable for Job.getLastBuild().
RunT	getNearestBuild(int n) Suitable for Job.getNearestBuild(int).
RunT	getNearestOldBuild(int n) Suitable for Job.getNearestOldBuild(int).
RunMap<RunT>	getRunMap() Gets the raw model.
RunT	loadBuild(File dir) Loads an existing build record from disk.
RunT	newBuild() Creates a new build of this project for immediate execution.
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).
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 Detail

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 Detail

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().

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(). 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).

createHistoryWidget

public final HistoryWidget createHistoryWidget()

Suitable for Job.createHistoryWidget().