org.apache.maven.plugins.dependency.fromDependencies.AbstractFromDependenciesMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-dependency-plugin Show documentation
There is a newer version: 3.8.1
Show newest version
/*
 * 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.plugins.annotations.Parameter;

/**
 * Abstract Parent class used by mojos that get Artifact information from the project dependencies.
 *
 * @author Brian Fox
 */
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;

    /**
     * 
     * Place each artifact in the same directory layout as a default repository.
     * 
     * 
     * example:
     * 
     *
     *      *   /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
     * 
     *
     * @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 /outputDirectory/junit-3.8.1-jar)
     *
     * @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;

    /**
     * @return Returns the outputDirectory.
     */
    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;
    }
}