Package org.apache.maven.plugins.dependency

Class AbstractDependencyMojo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.sonatype.plexus.build.incremental.BuildContext buildContext
      For IDE build support.
      private org.apache.maven.project.MavenProject project
      POM.
      protected org.apache.maven.execution.MavenSession session
      The Maven session.
      private boolean silent
      Deprecated.
      to be removed in 4.0; use -q command line option instead
      private boolean skip
      Skip plugin execution completely.
      private boolean skipDuringIncrementalBuild
      Skip plugin execution only during incremental builds (e.g.

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

        ROLE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractDependencyMojo​(org.apache.maven.execution.MavenSession session, org.sonatype.plexus.build.incremental.BuildContext buildContext, org.apache.maven.project.MavenProject project)  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected abstract void doExecute()  
      void execute()  
      protected static boolean existsInResolvedModel​(org.apache.maven.project.MavenProject project, DependencyEntry coords, boolean managed)
      Checks whether the dependency exists in the project's declared (original) model after property interpolation, but before inheritance merging.
      org.apache.maven.project.MavenProject getProject()  
      protected boolean isSilent()
      Deprecated.
      to be removed in 4.0
      boolean isSkip()  
      void setSilent​(boolean silent)
      Deprecated.
      to be removed in 4.0; no API replacement, use -q command line option instead
      void setSkip​(boolean skip)  

      • 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

      • session

        protected final org.apache.maven.execution.MavenSession session
        The Maven session.

      • silent

        @Deprecated
@Parameter(property="silent",
           defaultValue="false")
private boolean silent
        Deprecated.
        to be removed in 4.0; use -q command line option instead
        If the plugin should be silent.
        Since:
        2.0

      • skip

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

      • skipDuringIncrementalBuild

        @Parameter(defaultValue="false")
private boolean skipDuringIncrementalBuild
        Skip plugin execution only during incremental builds (e.g. triggered from M2E).
        Since:
        3.4.0
        See Also:
        skip

      • buildContext

        private final org.sonatype.plexus.build.incremental.BuildContext buildContext
        For IDE build support.

      • project

        private final org.apache.maven.project.MavenProject project
        POM.

    • Constructor Detail

      • AbstractDependencyMojo

        protected AbstractDependencyMojo​(org.apache.maven.execution.MavenSession session,
                                 org.sonatype.plexus.build.incremental.BuildContext buildContext,
                                 org.apache.maven.project.MavenProject project)

    • Method Detail

      • execute

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

      • doExecute

        protected abstract void doExecute()
                           throws org.apache.maven.plugin.MojoExecutionException,
                                  org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException - MojoExecutionException
        org.apache.maven.plugin.MojoFailureException - MojoFailureException

      • getProject

        public org.apache.maven.project.MavenProject getProject()
        Returns:
        returns the project

      • isSkip

        public boolean isSkip()
        Returns:
        skip

      • setSkip

        public void setSkip​(boolean skip)
        Parameters:
        skip - skip

      • isSilent

        @Deprecated
protected final boolean isSilent()
        Deprecated.
        to be removed in 4.0
        Returns:
        silent

      • setSilent

        @Deprecated
public void setSilent​(boolean silent)
        Deprecated.
        to be removed in 4.0; no API replacement, use -q command line option instead
        Parameters:
        silent - silent

      • existsInResolvedModel

        protected static boolean existsInResolvedModel​(org.apache.maven.project.MavenProject project,
                                               DependencyEntry coords,
                                               boolean managed)
        Checks whether the dependency exists in the project's declared (original) model after property interpolation, but before inheritance merging. This catches dependencies declared with property references like ${project.groupId} without false-positiving on inherited dependencies from a parent POM.