org.apache.maven.plugins.invoker.model

Class BuildJob

java.lang.Object

org.apache.maven.plugins.invoker.model.BuildJob

All Implemented Interfaces:

Serializable

public class BuildJob
extends Object
implements Serializable

Describes a build job processed by the Maven Invoker Plugin. A build job can consist of a pre-build hook script, one ore more invocations of Maven and a post-build hook script.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildJob.Result The various results with which a build job can complete.
static class	BuildJob.Type The various types of a build job.

Constructor Summary

Constructors

Constructor and Description
BuildJob() Creates a new empty build job.
BuildJob(String project) Creates a new build job with the specified project path.

Method Summary

Modifier and Type	Method and Description
String	getBuildlog() Get the build log filename.
String	getDescription() Get the description of this build job.
String	getFailureMessage() Get any failure message(s) in case this build job failed.
String	getModelEncoding() Get the modelEncoding field.
String	getName() Get the name of this build job.
int	getOrdinal() Get buildJobs will be sorted in the descending order of the ordinal.
String	getProject() Get the path to the project to build.
String	getResult() Get the result of this build job.
float	getTime() Get the number of seconds that this build job took to complete.
String	getType() Get the type of the build job.
boolean	isNotError()
void	setBuildlog(String buildlog) Set the build log filename.
void	setDescription(String description) Set the description of this build job.
void	setFailureMessage(String failureMessage) Set any failure message(s) in case this build job failed.
void	setModelEncoding(String modelEncoding) Set the modelEncoding field.
void	setName(String name) Set the name of this build job.
void	setOrdinal(int ordinal) Set buildJobs will be sorted in the descending order of the ordinal.
void	setProject(String project) Set the path to the project to build.
void	setResult(String result) Set the result of this build job.
void	setTime(float time) Set the number of seconds that this build job took to complete.
void	setType(String type) Set the type of the build job.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BuildJob

public BuildJob()

Creates a new empty build job.

BuildJob

public BuildJob(String project)

Creates a new build job with the specified project path.

Parameters:

project - The path to the project.

Method Detail

getBuildlog

public String getBuildlog()

Get the build log filename.

Returns:

String

getDescription

public String getDescription()

Get the description of this build job.

Returns:

String

getFailureMessage

public String getFailureMessage()

Get any failure message(s) in case this build job failed.

Returns:

String

getModelEncoding

public String getModelEncoding()

Get the modelEncoding field.

Returns:

String

getName

public String getName()

Get the name of this build job.

Returns:

String

getOrdinal

public int getOrdinal()

Get buildJobs will be sorted in the descending order of the ordinal. In other words, the BuildJobs with the highest numbers will be executed first.

Returns:

int

getProject

public String getProject()

Get the path to the project to build. This path is usually relative and can denote both a POM file or a project directory.

Returns:

String

getResult

public String getResult()

Get the result of this build job.

Returns:

String

getTime

public float getTime()

Get the number of seconds that this build job took to complete.

Returns:

float

getType

public String getType()

Get the type of the build job.

Returns:

String

setBuildlog

public void setBuildlog(String buildlog)

Set the build log filename.

Parameters:

buildlog - a buildlog object.

setDescription

public void setDescription(String description)

Set the description of this build job.

Parameters:

description - a description object.

setFailureMessage

public void setFailureMessage(String failureMessage)

Set any failure message(s) in case this build job failed.

Parameters:

failureMessage - a failureMessage object.

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set the modelEncoding field.

Parameters:

modelEncoding - a modelEncoding object.

setName

public void setName(String name)

Set the name of this build job.

Parameters:

name - a name object.

setOrdinal

public void setOrdinal(int ordinal)

Set buildJobs will be sorted in the descending order of the ordinal. In other words, the BuildJobs with the highest numbers will be executed first.

Parameters:

ordinal - a ordinal object.

setProject

public void setProject(String project)

Set the path to the project to build. This path is usually relative and can denote both a POM file or a project directory.

Parameters:

project - a project object.

setResult

public void setResult(String result)

Set the result of this build job.

Parameters:

result - a result object.

setTime

public void setTime(float time)

Set the number of seconds that this build job took to complete.

Parameters:

time - a time object.

setType

public void setType(String type)

Set the type of the build job.

Parameters:

type - a type object.

isNotError

public boolean isNotError()

toString

public String toString()

Overrides:

toString in class Object