org.apache.maven.plugins.dependency.PropertiesMojo Maven / Gradle / Ivy
/*
* 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;
import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
/**
* Goal that sets a property pointing to the artifact file for each project dependency. For each dependency (direct and
* transitive) a project property will be set which follows the groupId:artifactId:type:[classifier]
form
* and contains the path to the resolved artifact.
*
* @author Paul Gier
* @since 2.2
*/
// CHECKSTYLE_OFF: LineLength
@Mojo(
name = "properties",
requiresDependencyResolution = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.INITIALIZE,
threadSafe = true)
// CHECKSTYLE_ON: LineLength
public class PropertiesMojo extends AbstractMojo {
/**
* The current Maven project
*/
@Component
private MavenProject project;
/**
* Skip plugin execution completely.
*
* @since 2.7
*/
@Parameter(property = "mdep.skip", defaultValue = "false")
private boolean skip;
/**
* Main entry into mojo. Gets the list of dependencies and iterates through setting a property for each artifact.
*
* @throws MojoExecutionException with a message if an error occurs.
*/
@Override
public void execute() throws MojoExecutionException {
if (isSkip()) {
getLog().info("Skipping plugin execution");
return;
}
Set artifacts = project.getArtifacts();
for (Artifact artifact : artifacts) {
project.getProperties()
.setProperty(
artifact.getDependencyConflictId(),
artifact.getFile().getAbsolutePath());
}
}
/**
* @return {@link #skip}
*/
public boolean isSkip() {
return skip;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy