/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
    *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   */
  package org.apache.maven.plugins.dependency.fromDependencies;
  
  import java.io.File;
  
  import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
  import org.apache.maven.execution.MavenSession;
  import org.apache.maven.plugins.annotations.Parameter;
  import org.apache.maven.plugins.dependency.utils.ResolverUtil;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.project.ProjectBuilder;
  import org.sonatype.plexus.build.incremental.BuildContext;
  
  /**
   * Abstract Parent class used by mojos that get Artifact information from the project dependencies.
   *
   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
   */
  public abstract class AbstractFromDependenciesMojo extends AbstractDependencyFilterMojo {
      /**
       * Output location.
       *
       * @since 1.0
       */
      @Parameter(property = "outputDirectory", defaultValue = "${project.build.directory}/dependency")
      protected File outputDirectory;
  
      /**
       * Strip artifact version during copy.
       */
      @Parameter(property = "mdep.stripVersion", defaultValue = "false")
      protected boolean stripVersion = false;
  
      /**
       * Strip artifact type during copy.
       *
       * @since 3.4.0
       */
      @Parameter(property = "mdep.stripType", defaultValue = "false")
      protected boolean stripType = false;
  
      /**
       * Strip artifact classifier during copy.
       */
      @Parameter(property = "mdep.stripClassifier", defaultValue = "false")
      protected boolean stripClassifier = false;
  
      /**
       * <p>
       * Place each artifact in the same directory layout as a default repository.
       * </p>
       * <p>
       * example:
       * </p>
       *
       * <pre>
       *   /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
       * </pre>
       *
       * @since 2.0-alpha-2
       */
      @Parameter(property = "mdep.useRepositoryLayout", defaultValue = "false")
      protected boolean useRepositoryLayout;
  
      /**
       * Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided
       * etc.)
       *
       * @since 2.2
       */
      @Parameter(property = "mdep.useSubDirectoryPerScope", defaultValue = "false")
      protected boolean useSubDirectoryPerScope;
  
      /**
       * Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc.)
       *
       * @since 2.0-alpha-1
       */
      @Parameter(property = "mdep.useSubDirectoryPerType", defaultValue = "false")
      protected boolean useSubDirectoryPerType;
  
      /**
      * Place each file in a separate subdirectory. (example <code>/outputDirectory/junit-3.8.1-jar</code>)
      *
      * @since 2.0-alpha-1
      */
     @Parameter(property = "mdep.useSubDirectoryPerArtifact", defaultValue = "false")
     protected boolean useSubDirectoryPerArtifact;
 
     /**
      * This only applies if the classifier parameter is used.
      *
      * @since 2.0-alpha-2
      */
     @Parameter(property = "mdep.failOnMissingClassifierArtifact", defaultValue = "false")
     protected boolean failOnMissingClassifierArtifact;
 
     protected AbstractFromDependenciesMojo(
             MavenSession session,
             BuildContext buildContext,
             MavenProject project,
             ResolverUtil resolverUtil,
             ProjectBuilder projectBuilder,
             ArtifactHandlerManager artifactHandlerManager) {
         super(session, buildContext, project, resolverUtil, projectBuilder, artifactHandlerManager);
     }
 
     /**
      * @return returns the output directory
      */
     public File getOutputDirectory() {
         return this.outputDirectory;
     }
 
     /**
      * @param theOutputDirectory the outputDirectory to set
      */
     public void setOutputDirectory(File theOutputDirectory) {
         this.outputDirectory = theOutputDirectory;
     }
 
     /**
      * @return returns the useSubDirectoryPerArtifact
      */
     public boolean isUseSubDirectoryPerArtifact() {
         return this.useSubDirectoryPerArtifact;
     }
 
     /**
      * @param theUseSubDirectoryPerArtifact the useSubDirectoryPerArtifact to set
      */
     public void setUseSubDirectoryPerArtifact(boolean theUseSubDirectoryPerArtifact) {
         this.useSubDirectoryPerArtifact = theUseSubDirectoryPerArtifact;
     }
 
     /**
      * @return returns the useSubDirectoryPerScope
      */
     public boolean isUseSubDirectoryPerScope() {
         return this.useSubDirectoryPerScope;
     }
 
     /**
      * @param theUseSubDirectoryPerScope the useSubDirectoryPerScope to set
      */
     public void setUseSubDirectoryPerScope(boolean theUseSubDirectoryPerScope) {
         this.useSubDirectoryPerScope = theUseSubDirectoryPerScope;
     }
 
     /**
      * @return returns the useSubDirectoryPerType
      */
     public boolean isUseSubDirectoryPerType() {
         return this.useSubDirectoryPerType;
     }
 
     /**
      * @param theUseSubDirectoryPerType the useSubDirectoryPerType to set
      */
     public void setUseSubDirectoryPerType(boolean theUseSubDirectoryPerType) {
         this.useSubDirectoryPerType = theUseSubDirectoryPerType;
     }
 
     /**
      * @return {@link #failOnMissingClassifierArtifact}
      */
     public boolean isFailOnMissingClassifierArtifact() {
         return failOnMissingClassifierArtifact;
     }
 
     /**
      * @param failOnMissingClassifierArtifact {@link #failOnMissingClassifierArtifact}
      */
     public void setFailOnMissingClassifierArtifact(boolean failOnMissingClassifierArtifact) {
         this.failOnMissingClassifierArtifact = failOnMissingClassifierArtifact;
     }
 
     /**
      * @return {@link #stripVersion}
      */
     public boolean isStripVersion() {
         return stripVersion;
     }
 
     /**
      * @param stripVersion {@link #stripVersion}
      */
     public void setStripVersion(boolean stripVersion) {
         this.stripVersion = stripVersion;
     }
 
     /**
      * @return {@link #stripType}
      */
     public boolean isStripType() {
         return stripType;
     }
 
     /**
      * @param stripType {@link #stripType}
      */
     public void setStripType(boolean stripType) {
         this.stripType = stripType;
     }
 
     /**
      * @return true, if dependencies must be planted in a repository layout
      */
     public boolean isUseRepositoryLayout() {
         return useRepositoryLayout;
     }
 
     /**
      * @param useRepositoryLayout true if dependencies must be planted in a repository layout
      */
     public void setUseRepositoryLayout(boolean useRepositoryLayout) {
         this.useRepositoryLayout = useRepositoryLayout;
     }
 }