public class JobWithDetails extends Job
Modifier and Type | Field and Description |
---|---|
static String |
EMPTY_DESCRIPTION
Empty description to be used for
updateDescription(String) or
updateDescription(String, boolean) . |
Constructor and Description |
---|
JobWithDetails() |
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. |
public static final String EMPTY_DESCRIPTION
updateDescription(String)
or
updateDescription(String, boolean)
.public String getDescription()
public boolean hasDescription()
public String getDisplayName()
public boolean isBuildable()
public boolean isInQueue()
public List<Build> getBuilds()
getAllBuilds()
.Build
. In case of no builds have been
executed yet return Collections.emptyList()
.public List<Build> getAllBuilds() throws IOException
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.Build
. In case of no builds have been
executed yet return Collections.emptyList()
.IOException
- In case of failure.public List<Build> getAllBuilds(Range range) throws IOException
getAllBuilds()
.range
- Range
Build
. In case of no builds have been
executed yet return Collections.emptyList()
.IOException
- in case of an error.public Build getFirstBuild()
Build.BUILD_HAS_NEVER_RUN
if the build has never been
run.public boolean hasFirstBuildRun()
firstBuild
has been run or not.true
if a build has been run false
otherwise.public Build getLastBuild()
lastBuild
has never been run
Build.BUILD_HAS_NEVER_RUN
will be returned.public boolean hasLastBuildRun()
lastBuild
has been run or not.true
if the last build has been run
false
otherwise.public Build getLastCompletedBuild()
lastCompletedBuild
has never
been run Build.BUILD_HAS_NEVER_RUN
will be returned.public boolean hasLastCompletedBuildRun()
lastCompletedBuild
has been run or not.true
if the last completed build has been run
false
otherwise.public Build getLastFailedBuild()
lastFailedBuild
has never been
run Build.BUILD_HAS_NEVER_RUN
will be returned.public boolean hasLastFailedBuildRun()
lastFailedBuild
has been run or not.true
if the last failed build has been run
false
otherwise.public Build getLastStableBuild()
lastStableBuild
has never been
run Build.BUILD_HAS_NEVER_RUN
will be returned.public boolean hasLastStableBuildRun()
lastStableBuild
has been run or not.true
if the last stable build has been run
false
otherwise.public Build getLastSuccessfulBuild()
lastSuccessfulBuild
has
never been run Build.BUILD_HAS_NEVER_RUN
will be
returned.public boolean hasLastSuccessfulBuildRun()
lastSuccessfulBuild
has been run or not.true
if the last successful build has been run
false
otherwise.public Build getLastUnstableBuild()
lastUnstableBuild
has never
been run Build.BUILD_HAS_NEVER_RUN
will be returned.public boolean hasLastUnstableBuildRun()
lastUnstableBuild
has been run or not.true
if the last unstable build has been run
false
otherwise.public Build getLastUnsuccessfulBuild()
lastUnsuccessfulBuild
has
never been run Build.BUILD_HAS_NEVER_RUN
will be
returned.public boolean hasLastUnsuccessfulBuildRun()
lastUnsuccessfulBuild
has been run or not.true
if the last unsuccessful build has been run
false
otherwise.public int getNextBuildNumber()
public List<Job> getDownstreamProjects()
Collections.emptyList()
.public List<Job> getUpstreamProjects()
Collections.emptyList()
.public QueueItem getQueueItem()
public Build getBuildByNumber(int buildNumber)
buildNumber
- The number to select the build by.Build
selected by the given buildnumberpublic void updateDescription(String description) throws IOException
description
of a Job.description
- The description which should be set. If you like to
set an empty description you should use
EMPTY_DESCRIPTION
.IOException
- in case of errors.public void updateDescription(String description, boolean crumbFlag) throws IOException
description
of a Job.description
- The description which should be set. If you like to
set an empty description you should use
EMPTY_DESCRIPTION
.crumbFlag
- true
or false
.IOException
- in case of errors.public void clearDescription() throws IOException
IOException
- in case of errors.public void clearDescription(boolean crumbFlag) throws IOException
crumbFlag
- true
or false
.IOException
- in case of errors.Copyright © 2017 JBoss by Red Hat. All rights reserved.