Class JandexGoal

  • All Implemented Interfaces:
    org.apache.maven.plugin.Mojo

    public class JandexGoal
    extends java.lang.Object
    implements org.apache.maven.plugin.Mojo
    Generate a Jandex index for classes compiled as part of the current project.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.File classesDir
      By default, process the classes compiled for the project.
      private java.util.List<FileSet> fileSets
      Process the classes found in these file-sets, after considering the specified includes and excludes, if any.
      private java.lang.String indexName
      The name of the index file.
      private org.apache.maven.plugin.logging.Log log  
      private boolean processDefaultFileSet
      If true, construct an implied file-set using the target/classes directory, and process the classes there.
      private boolean skip
      Skip execution if set.
      private boolean verbose
      Print verbose output (debug output without needing to enable -X for the whole build)
      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE
    • Constructor Summary

      Constructors 
      Constructor Description
      JandexGoal()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private boolean doVerbose()  
      void execute()  
      java.lang.String getIndexName()  
      org.apache.maven.plugin.logging.Log getLog()  
      boolean isSkip()  
      boolean isVerbose()  
      void setIndexName​(java.lang.String indexName)  
      void setLog​(org.apache.maven.plugin.logging.Log log)  
      void setSkip​(boolean skip)  
      void setVerbose​(boolean verbose)  
      • Methods inherited from class java.lang.Object

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

      • classesDir

        private java.io.File classesDir
        By default, process the classes compiled for the project. If you need to process other sets of classes, such as test classes, see the "fileSets" parameter.
      • fileSets

        private java.util.List<FileSet> fileSets
        Process the classes found in these file-sets, after considering the specified includes and excludes, if any. The format is:
         
         <fileSets>
           <fileSet>
             <directory>path-or-expression</directory>
             <includes>
               <include>some/thing/*.good</include>
             <includes>
             <excludes>
               <exclude>some/thing/*.bad</exclude>
             </excludes<
           </fileSet>
         </fileSets>
         
         

        NOTE: Standard globbing expressions are supported in includes/excludes.
      • processDefaultFileSet

        private boolean processDefaultFileSet
        If true, construct an implied file-set using the target/classes directory, and process the classes there.
      • verbose

        private boolean verbose
        Print verbose output (debug output without needing to enable -X for the whole build)
      • indexName

        private java.lang.String indexName
        The name of the index file. Default's to 'jandex.idx'
      • skip

        private boolean skip
        Skip execution if set.
      • log

        private org.apache.maven.plugin.logging.Log log
    • Constructor Detail

      • JandexGoal

        public JandexGoal()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException
        Specified by:
        execute in interface org.apache.maven.plugin.Mojo
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
      • doVerbose

        private boolean doVerbose()
      • isVerbose

        public boolean isVerbose()
      • setVerbose

        public void setVerbose​(boolean verbose)
      • isSkip

        public boolean isSkip()
      • setSkip

        public void setSkip​(boolean skip)
      • setLog

        public void setLog​(org.apache.maven.plugin.logging.Log log)
        Specified by:
        setLog in interface org.apache.maven.plugin.Mojo
      • getLog

        public org.apache.maven.plugin.logging.Log getLog()
        Specified by:
        getLog in interface org.apache.maven.plugin.Mojo
      • getIndexName

        public java.lang.String getIndexName()
      • setIndexName

        public void setIndexName​(java.lang.String indexName)