Class ListClassesMojo

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

    @Mojo(name="list-classes",
          requiresProject=false,
          threadSafe=true)
    public class ListClassesMojo
    extends org.apache.maven.plugin.AbstractMojo
    Retrieves and lists all classes contained in the specified artifact from the specified remote repositories.
    Since:
    3.1.3
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private ParamArtifact paramArtifact  
      private java.util.List<java.lang.String> remoteRepositories
      Repositories in the format id::[layout::]url or just URLs.
      private ResolverUtil resolverUtil  
      private boolean skip
      Skip plugin execution completely.
      private boolean transitive
      Download transitively, retrieving the specified artifact and all of its dependencies.
      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE
    • Constructor Summary

      Constructors 
      Constructor Description
      ListClassesMojo()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void execute()  
      private void printClassesFromArtifactResult​(java.io.File file)  
      void setArtifact​(java.lang.String artifact)
      A string of the form groupId:artifactId:version[:packaging[:classifier]].
      void setArtifactId​(java.lang.String artifactId)
      The artifact ID of the artifact to download.
      void setClassifier​(java.lang.String classifier)
      The classifier of the artifact to download.
      void setGroupId​(java.lang.String groupId)
      The group ID of the artifact to download.
      void setPackaging​(java.lang.String packaging)
      The packaging of the artifact to download.
      void setVersion​(java.lang.String version)
      The version of the artifact to download.
      • 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

      • resolverUtil

        @Component
        private ResolverUtil resolverUtil
      • remoteRepositories

        @Parameter(property="remoteRepositories")
        private java.util.List<java.lang.String> remoteRepositories
        Repositories in the format id::[layout::]url or just URLs. That is, central::default::https://repo.maven.apache.org/maven2,myrepo::https://repo.acme.com,https://repo.acme2.com
        Since:
        3.1.3
      • transitive

        @Parameter(property="transitive",
                   defaultValue="false")
        private boolean transitive
        Download transitively, retrieving the specified artifact and all of its dependencies.
        Since:
        3.1.3
      • skip

        @Parameter(property="mdep.skip",
                   defaultValue="false")
        private boolean skip
        Skip plugin execution completely.
        Since:
        3.6.0
    • Constructor Detail

      • ListClassesMojo

        public ListClassesMojo()
    • Method Detail

      • setGroupId

        @Parameter(property="groupId")
        public void setGroupId​(java.lang.String groupId)
        The group ID of the artifact to download. Ignored if artifact is used.
        Since:
        3.1.3
      • setArtifactId

        @Parameter(property="artifactId")
        public void setArtifactId​(java.lang.String artifactId)
        The artifact ID of the artifact to download. Ignored if artifact is used.
        Since:
        3.1.3
      • setVersion

        @Parameter(property="version")
        public void setVersion​(java.lang.String version)
        The version of the artifact to download. Ignored if artifact is used.
        Since:
        3.1.3
      • setClassifier

        @Parameter(property="classifier")
        public void setClassifier​(java.lang.String classifier)
        The classifier of the artifact to download. Ignored if artifact is used.
        Since:
        3.1.3
      • setPackaging

        @Parameter(property="packaging",
                   defaultValue="jar")
        public void setPackaging​(java.lang.String packaging)
        The packaging of the artifact to download. Ignored if artifact is used.
        Since:
        3.1.3
      • setArtifact

        @Parameter(property="artifact")
        public void setArtifact​(java.lang.String artifact)
        A string of the form groupId:artifactId:version[:packaging[:classifier]].
        Since:
        3.1.3
      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
      • printClassesFromArtifactResult

        private void printClassesFromArtifactResult​(java.io.File file)
                                             throws java.io.IOException
        Throws:
        java.io.IOException