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 build log filename.Get 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.floatgetTime()Get the number of seconds that this build job took to complete.getType()Get the type of the build job.booleanvoidsetBuildlog(String buildlog) Set the build log filename.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(float 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.- Parameters:
project- The path to the project.
-
-
Method Details
-
getBuildlog
Get the build log filename.- Returns:
- String
-
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 float getTime()Get the number of seconds that this build job took to complete.- Returns:
- float
-
getType
Get the type of the build job.- Returns:
- String
-
setBuildlog
Set the build log filename.- Parameters:
buildlog- a buildlog object.
-
setDescription
Set the description of this build job.- Parameters:
description- a description object.
-
setFailureMessage
Set any failure message(s) in case this build job failed.- Parameters:
failureMessage- a failureMessage object.
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding- a modelEncoding object.
-
setName
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
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
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
Set the type of the build job.- Parameters:
type- a type object.
-
isNotError
public boolean isNotError() -
toString
-