com.github.cowwoc.requirements.maven.OptimizeExceptionsMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven_plugin Show documentation

Maven plugin for the Requirements library

There is a newer version: 8.0.10

/*
 * Copyright (c) 2018 Gili Tzabari
 * Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
 */
package com.github.cowwoc.requirements.maven;

import com.github.cowwoc.requirements.generator.ExceptionOptimizer;
import org.apache.maven.plugin.MojoExecutionException;
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.project.MavenProject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;

/**
 * Optimizes the exceptions thrown by the library, such as evaluating stack traces are lazily. See
 * {@code com.github.cowwoc.requirements.java.GlobalConfiguration.isCleanStackTrace()}.
 */
@Mojo(name = "optimize-exceptions", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true)
@SuppressWarnings("MismatchedQueryAndUpdateOfCollection")
public final class OptimizeExceptionsMojo extends AbstractGeneratorMojo
{
	@Parameter(defaultValue = "${project.build.directory}", readonly = true)
	private File targetDirectory;

	/**
	 * The scope to export for. One of {@code [compile, test]}.
	 */
	@Parameter(property = "scope", defaultValue = "compile")
	private String scope;
	/**
	 * The list of exceptions to optimize. Each entry is expected to contain a fully-qualified class name.
	 */
	@Parameter(property = "exceptions")
	private List exceptions;

	@Parameter(property = "project", required = true, readonly = true)
	private MavenProject project;

	@Override
	public void execute() throws MojoExecutionException
	{
		Path generatedSources = getGeneratedSourcesPath(scope, targetDirectory.toPath());
		ExceptionOptimizer optimizer = new ExceptionOptimizer();
		try
		{
			Files.createDirectories(generatedSources);
		}
		catch (IOException e)
		{
			getLog().error("Failed to create: " + generatedSources.toAbsolutePath());
			throw new MojoExecutionException("", e);
		}
		try
		{
			Logger log = LoggerFactory.getLogger(ExceptionOptimizer.class);
			for (String exceptionName : exceptions)
			{
				Class exception;
				try
				{
					exception = Class.forName(exceptionName);
				}
				catch (ClassNotFoundException e)
				{
					log.error("Cannot find " + exceptionName);
					continue;
				}
				optimizer.apply(generatedSources, exception);
			}
		}
		catch (IOException e)
		{
			throw new MojoExecutionException("", e);
		}
		addFilesToSources(project, scope, generatedSources);
	}
}