com.offbytwo.jenkins.model

Class Build

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Build

Direct Known Subclasses:

BuildWithDetails, MavenBuild

public class Build
extends BaseModel

Field Summary

Fields

Modifier and Type	Field and Description
static Build	BUILD_HAS_BEEN_CANCELLED This will be returned by the API in cases where a build has been cancelled.
static Build	BUILD_HAS_NEVER_RUN This will be returned by the API in cases where no build has ever been executed like JobWithDetails.getLastBuild() etc.

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

client

Constructor Summary

Constructors

Constructor and Description
Build()
Build(Build from)
Build(int number, String url)

Method Summary

Modifier and Type	Method and Description
BuildWithDetails	details()
boolean	equals(Object obj)
int	getNumber()
int	getQueueId()
TestReport	getTestReport() This is to get the information about TestReport for a Maven Job type.
TestResult	getTestResult() This is to get the information about run tests for a non Maven job type.
String	getUrl()
int	hashCode()
protected void	setNumber(int number)
protected void	setQueueId(int queueId)
protected void	setUrl(String url)
String	Stop()
String	Stop(boolean crumbFlag) Stops the build which is currently in progress.

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

BUILD_HAS_NEVER_RUN

public static final Build BUILD_HAS_NEVER_RUN

This will be returned by the API in cases where no build has ever been executed like JobWithDetails.getLastBuild() etc. This will also be returned by details() is the build has not been run.

BUILD_HAS_BEEN_CANCELLED

public static final Build BUILD_HAS_BEEN_CANCELLED

This will be returned by the API in cases where a build has been cancelled.

Constructor Detail

Build

public Build()

Build

public Build(Build from)

Build

public Build(int number,
             String url)

Method Detail

getNumber

public int getNumber()

getQueueId

public int getQueueId()

getUrl

public String getUrl()

setNumber

protected void setNumber(int number)

setQueueId

protected void setQueueId(int queueId)

setUrl

protected void setUrl(String url)

details

public BuildWithDetails details()
                         throws IOException

Returns:

The information from Jenkins. In cases the build has never run BUILD_HAS_NEVER_RUN will be returned.

Throws:

IOException - in case of an error.

getTestReport

public TestReport getTestReport()
                         throws IOException

This is to get the information about TestReport for a Maven Job type.

Returns:

TestReport

Throws:

IOException - in case of an error.

getTestResult

public TestResult getTestResult()
                         throws IOException

This is to get the information about run tests for a non Maven job type.

Returns:

TestResult

Throws:

IOException - in case of an error.

Stop

public String Stop()
            throws org.apache.http.client.HttpResponseException,
                   IOException

Throws:

org.apache.http.client.HttpResponseException

IOException

Stop

public String Stop(boolean crumbFlag)
            throws org.apache.http.client.HttpResponseException,
                   IOException

Stops the build which is currently in progress. This version takes in a crumbFlag. In some cases , an error is thrown which reads "No valid crumb was included in the request". This stop method is used incase those issues occur

Parameters:

crumbFlag - flag used to specify if a crumb is passed into for the request

Returns:

the client url

Throws:

org.apache.http.client.HttpResponseException - in case of an error.

IOException - in case of an error.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object