org.apache.maven.plugin.invoker.model
Class BuildJob

java.lang.Object
  org.apache.maven.plugin.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

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

BuildJob()
Creates a new empty build job.

BuildJob(String project, String type)
Creates a new build job with the specified project path and type.

Method Summary

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.
String	getProject() Get the path to the project to build.
String	getResult() Get the result of this build job.
double	getTime() Get the number of seconds that this build job took to complete.
String	getType() Get the type of the build job.
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	setProject(String project) Set the path to the project to build.
void	setResult(String result) Set the result of this build job.
void	setTime(double 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,
                String type)

Creates a new build job with the specified project path and type.

Parameters:

project - The path to the project.

type - The type of the build job.

Method Detail

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

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 double getTime()

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

Returns:

double

getType

public String getType()

Get the type of the build job.

Returns:

String

setDescription

public void setDescription(String description)

Set the description of this build job.

Parameters:

description -

setFailureMessage

public void setFailureMessage(String failureMessage)

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

Parameters:

failureMessage -

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set the modelEncoding field.

Parameters:

modelEncoding -

setName

public void setName(String name)

Set the name of this build job.

Parameters:

name -

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 -

setResult

public void setResult(String result)

Set the result of this build job.

Parameters:

result -

setTime

public void setTime(double time)

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

Parameters:

time -

setType

public void setType(String type)

Set the type of the build job.

Parameters:

type -

toString

public String toString()

Overrides:

toString in class Object