com.offbytwo.jenkins.model

Class JobWithDetails

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Job

com.offbytwo.jenkins.model.JobWithDetails

public class JobWithDetails
extends Job

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_DESCRIPTION Empty description to be used for updateDescription(String) or updateDescription(String, boolean).

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
JobWithDetails()

Method Summary

Modifier and Type	Method and Description
void	clearDescription() clear the description of a job.
void	clearDescription(boolean crumbFlag) clear the description of a job.
boolean	equals(Object obj)
List<Build>	getAllBuilds() This method will give you back all builds which exists independent of the number.
List<Build>	getAllBuilds(Range range) {M,N}: From the M-th element (inclusive) to the N-th element (exclusive). {M,}: From the M-th element (inclusive) to the end. {,N}: From the first element (inclusive) to the N-th element (exclusive).
Build	getBuildByNumber(int buildNumber) Get a build by the given buildNumber.
List<Build>	getBuilds() This method will give you back the builds of a particular job.
String	getDescription()
String	getDisplayName()
List<Job>	getDownstreamProjects()
Build	getFirstBuild()
Build	getLastBuild()
Build	getLastCompletedBuild()
Build	getLastFailedBuild()
Build	getLastStableBuild()
Build	getLastSuccessfulBuild()
Build	getLastUnstableBuild()
Build	getLastUnsuccessfulBuild()
int	getNextBuildNumber()
QueueItem	getQueueItem()
List<Job>	getUpstreamProjects()
boolean	hasDescription()
boolean	hasFirstBuildRun() Check if the firstBuild has been run or not.
int	hashCode()
boolean	hasLastBuildRun() Check if the lastBuild has been run or not.
boolean	hasLastCompletedBuildRun() Check if the lastCompletedBuild has been run or not.
boolean	hasLastFailedBuildRun() Check if the lastFailedBuild has been run or not.
boolean	hasLastStableBuildRun() Check if the lastStableBuild has been run or not.
boolean	hasLastSuccessfulBuildRun() Check if the lastSuccessfulBuild has been run or not.
boolean	hasLastUnstableBuildRun() Check if the lastUnstableBuild has been run or not.
boolean	hasLastUnsuccessfulBuildRun() Check if the lastUnsuccessfulBuild has been run or not.
boolean	isBuildable()
boolean	isInQueue()
void	updateDescription(String description) Update the description of a Job.
void	updateDescription(String description, boolean crumbFlag) Update the description of a Job.

Methods inherited from class com.offbytwo.jenkins.model.Job

build, build, build, build, details, getFileFromWorkspace, getName, getUrl

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

get_class, getClient, setClient

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_DESCRIPTION

public static final String EMPTY_DESCRIPTION

Empty description to be used for updateDescription(String) or updateDescription(String, boolean).

See Also:

Constant Field Values

Constructor Detail

JobWithDetails

public JobWithDetails()

Method Detail

getDescription

public String getDescription()

hasDescription

public boolean hasDescription()

getDisplayName

public String getDisplayName()

isBuildable

public boolean isBuildable()

isInQueue

public boolean isInQueue()

getBuilds

public List<Build> getBuilds()

This method will give you back the builds of a particular job. Note: Jenkins limits the number of results to a maximum of 100 builds which you will get back.. In case you have more than 100 build you won't get back all builds via this method. In such cases you need to use getAllBuilds().

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

getAllBuilds

public List<Build> getAllBuilds()
                         throws IOException

This method will give you back all builds which exists independent of the number. You should be aware that this can be much in some cases if you have more than 100 builds which is by default limited by Jenkins getBuilds(). This method limits it to particular information which can be later used to get supplemental information about a particular build Build.details() to reduce the amount of data which needed to be transfered.

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

Throws:

IOException - In case of failure.

See Also:

Jenkins Issue

getAllBuilds

public List<Build> getAllBuilds(Range range)
                         throws IOException

• {M,N}: From the M-th element (inclusive) to the N-th element (exclusive).
• {M,}: From the M-th element (inclusive) to the end.
• {,N}: From the first element (inclusive) to the N-th element (exclusive). The same as {0,N}.
• {N}: Just retrieve the N-th element. The same as {N,N+1}.

Note: At the moment there seemed to be no option to get the number of existing builds for a job. The only option is to get all builds via getAllBuilds().

Parameters:

range - Range

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

Throws:

IOException - in case of an error.

getFirstBuild

public Build getFirstBuild()

Returns:

the first build which has been executed or Build.BUILD_HAS_NEVER_RUN if the build has never been run.

hasFirstBuildRun

public boolean hasFirstBuildRun()

Check if the firstBuild has been run or not.

Returns:

true if a build has been run false otherwise.

getLastBuild

public Build getLastBuild()

Returns:

The lastBuild. If lastBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastBuildRun

public boolean hasLastBuildRun()

Check if the lastBuild has been run or not.

Returns:

true if the last build has been run false otherwise.

getLastCompletedBuild

public Build getLastCompletedBuild()

Returns:

The lastCompletedBuild. If lastCompletedBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastCompletedBuildRun

public boolean hasLastCompletedBuildRun()

Check if the lastCompletedBuild has been run or not.

Returns:

true if the last completed build has been run false otherwise.

getLastFailedBuild

public Build getLastFailedBuild()

Returns:

The lastFailedBuild. If lastFailedBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastFailedBuildRun

public boolean hasLastFailedBuildRun()

Check if the lastFailedBuild has been run or not.

Returns:

true if the last failed build has been run false otherwise.

getLastStableBuild

public Build getLastStableBuild()

Returns:

The lastStableBuild. If lastStableBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastStableBuildRun

public boolean hasLastStableBuildRun()

Check if the lastStableBuild has been run or not.

Returns:

true if the last stable build has been run false otherwise.

getLastSuccessfulBuild

public Build getLastSuccessfulBuild()

Returns:

The lastSuccessfulBuild. If lastSuccessfulBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastSuccessfulBuildRun

public boolean hasLastSuccessfulBuildRun()

Check if the lastSuccessfulBuild has been run or not.

Returns:

true if the last successful build has been run false otherwise.

getLastUnstableBuild

public Build getLastUnstableBuild()

Returns:

The lastUnstableBuild. If lastUnstableBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastUnstableBuildRun

public boolean hasLastUnstableBuildRun()

Check if the lastUnstableBuild has been run or not.

Returns:

true if the last unstable build has been run false otherwise.

getLastUnsuccessfulBuild

public Build getLastUnsuccessfulBuild()

Returns:

The lastUnsuccessfulBuild. If lastUnsuccessfulBuild has never been run Build.BUILD_HAS_NEVER_RUN will be returned.

hasLastUnsuccessfulBuildRun

public boolean hasLastUnsuccessfulBuildRun()

Check if the lastUnsuccessfulBuild has been run or not.

Returns:

true if the last unsuccessful build has been run false otherwise.

getNextBuildNumber

public int getNextBuildNumber()

getDownstreamProjects

public List<Job> getDownstreamProjects()

Returns:

the list of downstream projects. If no downstream projects exist just return an empty list Collections.emptyList().

getUpstreamProjects

public List<Job> getUpstreamProjects()

Returns:

the list of upstream projects. If no upstream projects exist just return an empty list Collections.emptyList().

getQueueItem

public QueueItem getQueueItem()

getBuildByNumber

public Build getBuildByNumber(int buildNumber)

Get a build by the given buildNumber.

Parameters:

buildNumber - The number to select the build by.

Returns:

The Build selected by the given buildnumber

updateDescription

public void updateDescription(String description)
                       throws IOException

Update the description of a Job.

Parameters:

description - The description which should be set. If you like to set an empty description you should use EMPTY_DESCRIPTION.

Throws:

IOException - in case of errors.

updateDescription

public void updateDescription(String description,
                              boolean crumbFlag)
                       throws IOException

Update the description of a Job.

Parameters:

description - The description which should be set. If you like to set an empty description you should use EMPTY_DESCRIPTION.

crumbFlag - true or false.

Throws:

IOException - in case of errors.

clearDescription

public void clearDescription()
                      throws IOException

clear the description of a job.

Throws:

IOException - in case of errors.

clearDescription

public void clearDescription(boolean crumbFlag)
                      throws IOException

clear the description of a job.

Parameters:

crumbFlag - true or false.

Throws:

IOException - in case of errors.

hashCode

public int hashCode()

Overrides:

hashCode in class Job

equals

public boolean equals(Object obj)

Overrides:

equals in class Job