Class BuildJob
java.lang.Object
org.apache.maven.plugins.invoker.model.BuildJob
- All Implemented Interfaces:
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThe various results with which a build job can complete.static classThe various types of a build job. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the description of this build job.Get any failure message(s) in case this build job failed.Get the modelEncoding field.getName()Get the name of this build job.intGet buildJobs will be sorted in the descending order of the ordinal.Get the path to the project to build.Get the result of this build job.doublegetTime()Get the number of seconds that this build job took to complete.getType()Get the type of the build job.voidsetDescription(String description) Set the description of this build job.voidsetFailureMessage(String failureMessage) Set any failure message(s) in case this build job failed.voidsetModelEncoding(String modelEncoding) Set the modelEncoding field.voidSet the name of this build job.voidsetOrdinal(int ordinal) Set buildJobs will be sorted in the descending order of the ordinal.voidsetProject(String project) Set the path to the project to build.voidSet the result of this build job.voidsetTime(double time) Set the number of seconds that this build job took to complete.voidSet the type of the build job.toString()
-
Constructor Details
-
BuildJob
public BuildJob()Creates a new empty build job. -
BuildJob
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 Details
-
getDescription
Get the description of this build job.- Returns:
- String
-
getFailureMessage
Get any failure message(s) in case this build job failed.- Returns:
- String
-
getModelEncoding
Get the modelEncoding field.- Returns:
- 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
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
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
Get the type of the build job.- Returns:
- String
-
setDescription
Set the description of this build job.- Parameters:
description-
-
setFailureMessage
Set any failure message(s) in case this build job failed.- Parameters:
failureMessage-
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding-
-
setName
Set the name of this build job.- Parameters:
name-
-
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-
-
setProject
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
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
Set the type of the build job.- Parameters:
type-
-
toString
-