Package org.codehaus.modello.maven

Class AbstractModelloGeneratorMojo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String basedir
      Base directory of the project, from where the Modello models are loaded.
      private org.codehaus.plexus.build.BuildContext buildContext  
      private java.io.File licenseFile
      The file that contains license header text.
      private java.lang.String licenseText
      The contents of license header text, verbatim.
      private org.codehaus.modello.core.ModelloCore modelloCore  
      private java.lang.String[] models
      List of relative paths to mdo files containing the models.
      private java.util.List<java.lang.String> packagedVersions
      Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
      private boolean packageWithVersion
      True if the generated package names should include the version.
      private java.util.Map<java.lang.String,​java.lang.String> pluralExceptions
      Additional exceptions to the singularization rules, changing plural noun to singular.
      private org.apache.maven.project.MavenProject project
      The Maven project instance for the executing project.
      private java.lang.String version
      The version of the model we will be working on.

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractModelloGeneratorMojo​(org.codehaus.plexus.build.BuildContext buildContext, org.codehaus.modello.core.ModelloCore modelloCore)  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.Map<java.lang.String,​java.lang.Object> createParameters()
      Creates a Properties objects.
      protected void customizeParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Override this method to customize the values in the properties set.
      private void doExecute​(java.lang.String modelStr, java.lang.String outputDirectory, java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Performs execute on a single specified model.
      void execute()  
      java.lang.String getBasedir()  
      protected abstract java.lang.String getGeneratorType()  
      java.lang.String[] getModels()  
      abstract java.io.File getOutputDirectory()  
      boolean getPackageWithVersion()  
      org.apache.maven.project.MavenProject getProject()  
      java.lang.String getVersion()  
      protected boolean producesCompilableResult()  
      protected boolean producesResources()  
      void setBasedir​(java.lang.String basedir)  
      void setModels​(java.lang.String[] models)  
      void setPackagedVersions​(java.util.List<java.lang.String> packagedVersions)  
      void setPackageWithVersion​(boolean packageWithVersion)  
      void setProject​(org.apache.maven.project.MavenProject project)  
      void setVersion​(java.lang.String version)  

      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getLog, getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • basedir

        @Parameter(defaultValue="${basedir}",
           required=true)
private java.lang.String basedir
        Base directory of the project, from where the Modello models are loaded.

      • models

        @Parameter(required=true)
private java.lang.String[] models
        List of relative paths to mdo files containing the models.

      • version

        @Parameter(property="version",
           required=true)
private java.lang.String version
        The version of the model we will be working on.

      • packageWithVersion

        @Parameter(property="packageWithVersion",
           defaultValue="false",
           required=true)
private boolean packageWithVersion
        True if the generated package names should include the version.

      • project

        @Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
private org.apache.maven.project.MavenProject project
        The Maven project instance for the executing project.

      • packagedVersions

        @Parameter
private java.util.List<java.lang.String> packagedVersions
        Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.

      • licenseText

        @Parameter
private java.lang.String licenseText
        The contents of license header text, verbatim.
        Since:
        2.3.1

      • licenseFile

        @Parameter
private java.io.File licenseFile
        The file that contains license header text. If both configured, the licenseText prevails.
        Since:
        2.3.1

      • pluralExceptions

        @Parameter
private java.util.Map<java.lang.String,​java.lang.String> pluralExceptions
        Additional exceptions to the singularization rules, changing plural noun to singular.

        As a key we provide plural noun and as value we provide singular noun, example: 

             <kisses>kiss</kisses>
        Since:
        2.5.0

      • buildContext

        private final org.codehaus.plexus.build.BuildContext buildContext

      • modelloCore

        private final org.codehaus.modello.core.ModelloCore modelloCore

    • Constructor Detail

      • AbstractModelloGeneratorMojo

        protected AbstractModelloGeneratorMojo​(org.codehaus.plexus.build.BuildContext buildContext,
                                       org.codehaus.modello.core.ModelloCore modelloCore)

    • Method Detail

      • getGeneratorType

        protected abstract java.lang.String getGeneratorType()

      • getOutputDirectory

        public abstract java.io.File getOutputDirectory()

      • producesCompilableResult

        protected boolean producesCompilableResult()

      • producesResources

        protected boolean producesResources()

      • createParameters

        protected java.util.Map<java.lang.String,​java.lang.Object> createParameters()
        Creates a Properties objects.
        The abstract mojo will override the output directory, the version and the package with version flag.
        Returns:
        the parameters

      • customizeParameters

        protected void customizeParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Override this method to customize the values in the properties set.

        This method will be called after the parameters have been populated with the parameters in the abstract mojo.

        Parameters:
        parameters - the parameters to customize

      • execute

        public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • doExecute

        private void doExecute​(java.lang.String modelStr,
                       java.lang.String outputDirectory,
                       java.util.Map<java.lang.String,​java.lang.Object> parameters)
                throws org.apache.maven.plugin.MojoExecutionException
        Performs execute on a single specified model.
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • getBasedir

        public java.lang.String getBasedir()

      • setBasedir

        public void setBasedir​(java.lang.String basedir)

      • getVersion

        public java.lang.String getVersion()

      • setVersion

        public void setVersion​(java.lang.String version)

      • getPackageWithVersion

        public boolean getPackageWithVersion()

      • setPackageWithVersion

        public void setPackageWithVersion​(boolean packageWithVersion)

      • getProject

        public org.apache.maven.project.MavenProject getProject()

      • setProject

        public void setProject​(org.apache.maven.project.MavenProject project)

      • setPackagedVersions

        public void setPackagedVersions​(java.util.List<java.lang.String> packagedVersions)

      • getModels

        public java.lang.String[] getModels()
        Returns:
        Returns the paths to the models.

      • setModels

        public void setModels​(java.lang.String[] models)
        Parameters:
        models - Sets the paths to the models.