com.offbytwo.jenkins.model

Class MavenJobWithDetails

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Job

com.offbytwo.jenkins.model.MavenJob

com.offbytwo.jenkins.model.MavenJobWithDetails

public class MavenJobWithDetails
extends MavenJob

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
MavenJobWithDetails()

Method Summary

Modifier and Type	Method and Description
List<MavenBuild>	getAllBuilds() This method will give you back all builds which exists independent of the number.
List<MavenBuild>	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).
MavenBuild	getBuildByNumber(int buildNumber)
List<MavenBuild>	getBuilds() This method will give you back the builds of a particular job.
String	getDisplayName()
List<Job>	getDownstreamProjects()
MavenBuild	getFirstBuild()
MavenBuild	getLastBuild()
MavenBuild	getLastCompletedBuild()
MavenBuild	getLastFailedBuild()
MavenBuild	getLastStableBuild()
MavenBuild	getLastSuccessfulBuild()
MavenBuild	getLastUnstableBuild()
MavenBuild	getLastUnsuccessfulBuild()
int	getNextBuildNumber()
List<Job>	getUpstreamProjects()
boolean	isBuildable()

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

mavenDetails

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

build, build, build, build, build, build, details, equals, getFileFromWorkspace, getFullName, getName, getUrl, hashCode

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

Constructor Detail

MavenJobWithDetails

public MavenJobWithDetails()

Method Detail

getDisplayName

public String getDisplayName()

isBuildable

public boolean isBuildable()

getBuilds

public List<MavenBuild> 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 MavenBuild. In case of no builds have been executed yet Collections.emptyList() will be returned.

getAllBuilds

public List<MavenBuild> 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<MavenBuild> 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 MavenBuild getFirstBuild()

Returns:

The firstBuild. If firstBuild has never been run MavenBuild.BUILD_HAS_NEVER_RUN will be returned.

getLastBuild

public MavenBuild getLastBuild()

Returns:

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

getLastCompletedBuild

public MavenBuild getLastCompletedBuild()

Returns:

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

getLastFailedBuild

public MavenBuild getLastFailedBuild()

Returns:

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

getLastStableBuild

public MavenBuild getLastStableBuild()

Returns:

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

getLastSuccessfulBuild

public MavenBuild getLastSuccessfulBuild()

Returns:

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

getLastUnstableBuild

public MavenBuild getLastUnstableBuild()

Returns:

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

getLastUnsuccessfulBuild

public MavenBuild getLastUnsuccessfulBuild()

Returns:

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

getNextBuildNumber

public int getNextBuildNumber()

getDownstreamProjects

public List<Job> getDownstreamProjects()

getUpstreamProjects

public List<Job> getUpstreamProjects()

getBuildByNumber

public MavenBuild getBuildByNumber(int buildNumber)