Class BuildJob

  • All Implemented Interfaces:
    java.io.Serializable

    public class BuildJob
    extends java.lang.Object
    implements java.io.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 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.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String buildlog
      The build log filename.
      private java.lang.String description
      The description of this build job.
      private java.lang.String failureMessage
      Any failure message(s) in case this build job failed.
      private java.lang.String modelEncoding
      Field modelEncoding.
      private java.lang.String name
      The name of this build job.
      private int ordinal
      BuildJobs will be sorted in the descending order of the ordinal.
      private java.lang.String project
      The path to the project to build.
      private java.lang.String result
      The result of this build job.
      private float time
      The number of seconds that this build job took to complete.
      private java.lang.String type
      The type of the build job.
    • Constructor Summary

      Constructors 
      Constructor Description
      BuildJob()
      Creates a new empty build job.
      BuildJob​(java.lang.String project)
      Creates a new build job with the specified project path.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getBuildlog()
      Get the build log filename.
      java.lang.String getDescription()
      Get the description of this build job.
      java.lang.String getFailureMessage()
      Get any failure message(s) in case this build job failed.
      java.lang.String getModelEncoding()
      Get the modelEncoding field.
      java.lang.String getName()
      Get the name of this build job.
      int getOrdinal()
      Get buildJobs will be sorted in the descending order of the ordinal.
      java.lang.String getProject()
      Get the path to the project to build.
      java.lang.String getResult()
      Get the result of this build job.
      float getTime()
      Get the number of seconds that this build job took to complete.
      java.lang.String getType()
      Get the type of the build job.
      boolean isNotError()  
      void setBuildlog​(java.lang.String buildlog)
      Set the build log filename.
      void setDescription​(java.lang.String description)
      Set the description of this build job.
      void setFailureMessage​(java.lang.String failureMessage)
      Set any failure message(s) in case this build job failed.
      void setModelEncoding​(java.lang.String modelEncoding)
      Set the modelEncoding field.
      void setName​(java.lang.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​(java.lang.String project)
      Set the path to the project to build.
      void setResult​(java.lang.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​(java.lang.String type)
      Set the type of the build job.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • project

        private java.lang.String project
        The path to the project to build. This path is usually relative and can denote both a POM file or a project directory.
      • name

        private java.lang.String name
        The name of this build job.
      • description

        private java.lang.String description
        The description of this build job.
      • result

        private java.lang.String result
        The result of this build job.
      • failureMessage

        private java.lang.String failureMessage
        Any failure message(s) in case this build job failed.
      • time

        private float time
        The number of seconds that this build job took to complete.
      • type

        private java.lang.String type
        The type of the build job.
      • ordinal

        private int ordinal
        BuildJobs will be sorted in the descending order of the ordinal. In other words, the BuildJobs with the highest numbers will be executed first.
      • buildlog

        private java.lang.String buildlog
        The build log filename.
      • modelEncoding

        private java.lang.String modelEncoding
        Field modelEncoding.
    • Constructor Detail

      • BuildJob

        public BuildJob()
        Creates a new empty build job.
      • BuildJob

        public BuildJob​(java.lang.String project)
        Creates a new build job with the specified project path.
        Parameters:
        project - The path to the project.
    • Method Detail

      • getBuildlog

        public java.lang.String getBuildlog()
        Get the build log filename.
        Returns:
        String
      • getDescription

        public java.lang.String getDescription()
        Get the description of this build job.
        Returns:
        String
      • getFailureMessage

        public java.lang.String getFailureMessage()
        Get any failure message(s) in case this build job failed.
        Returns:
        String
      • getModelEncoding

        public java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String
      • getName

        public java.lang.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 java.lang.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 java.lang.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 java.lang.String getType()
        Get the type of the build job.
        Returns:
        String
      • setBuildlog

        public void setBuildlog​(java.lang.String buildlog)
        Set the build log filename.
        Parameters:
        buildlog - a buildlog object.
      • setDescription

        public void setDescription​(java.lang.String description)
        Set the description of this build job.
        Parameters:
        description - a description object.
      • setFailureMessage

        public void setFailureMessage​(java.lang.String failureMessage)
        Set any failure message(s) in case this build job failed.
        Parameters:
        failureMessage - a failureMessage object.
      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding - a modelEncoding object.
      • setName

        public void setName​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String type)
        Set the type of the build job.
        Parameters:
        type - a type object.
      • isNotError

        public boolean isNotError()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object