net.bytebuddy.build.gradle.Transformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of byte-buddy-gradle-plugin Show documentation
A plugin for post-processing class files via Byte Buddy in a Gradle build.
There is a newer version: 1.16.1
Show newest version
/*
 * Copyright 2014 - Present Rafael Winterhalter
 *
 * Licensed 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 net.bytebuddy.build.gradle;

import groovy.lang.Closure;
import net.bytebuddy.build.Plugin;
import net.bytebuddy.utility.nullability.MaybeNull;
import net.bytebuddy.utility.nullability.UnknownNull;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Project;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;

import javax.inject.Inject;
import java.util.ArrayList;
import java.util.List;

/**
 * A transformation specification to apply during the Gradle plugin's execution.
 */
public class Transformation {

    /**
     * The current project to use.
     */
    @UnknownNull
    private final transient Project project;

    /**
     * A list of arguments that are provided to the plugin for construction.
     */
    private final List arguments;

    /**
     * The plugin type.
     */
    @MaybeNull
    private Class plugin;

    /**
     * The fully-qualified name of the plugin type.
     */
    @MaybeNull
    private String pluginName;

    /**
     * Creates a new transformation without configuring a project. This constructor is for
     * internal use only as closures cannot be resolved.
     */
    public Transformation() {
        project = null;
        arguments = new ArrayList();
    }

    /**
     * Creates a new transformation.
     *
     * @param project The object factory to use.
     */
    @Inject
    public Transformation(Project project) {
        this.project = project;
        arguments = new ArrayList();
    }

    /**
     * Returns a list of arguments that are provided to the plugin for construction.
     *
     * @return A list of arguments that are provided to the plugin for construction.
     */
    @Input
    public List getArguments() {
        return arguments;
    }

    /**
     * Adds a plugin argument to consider during instantiation.
     *
     * @param closure The closure for configuring the argument.
     */
    public void argument(Closure closure) {
        getArguments().add((PluginArgument) project.configure(new PluginArgument(getArguments().size()), closure));
    }

    /**
     * Adds a plugin argument to consider during instantiation.
     *
     * @param action The action for configuring the argument.
     */
    public void argument(Action action) {
        PluginArgument argument = new PluginArgument(getArguments().size());
        action.execute(argument);
        getArguments().add(argument);
    }

    /**
     * Creates the argument resolvers for the plugin's constructor by transforming the plugin arguments.
     *
     * @return A list of argument resolvers.
     */
    protected List makeArgumentResolvers() {
        List argumentResolvers = new ArrayList();
        for (PluginArgument argument : getArguments()) {
            argumentResolvers.add(argument.toArgumentResolver());
        }
        return argumentResolvers;
    }

    /**
     * Returns the plugin type to apply.
     *
     * @return The plugin type to apply.
     */
    @Input
    @MaybeNull
    @Optional
    public Class getPlugin() {
        return plugin;
    }

    /**
     * Sets the plugin type to apply.
     *
     * @param plugin The plugin type to apply.
     */
    public void setPlugin(@MaybeNull Class plugin) {
        this.plugin = plugin;
    }

    /**
     * Returns the fully-qualified name of the plugin type to apply.
     *
     * @return The fully-qualified name of the plugin type to apply.
     */
    @Input
    @MaybeNull
    @Optional
    public String getPluginName() {
        return pluginName;
    }

    /**
     * Sets the fully-qualified name of the plugin type to apply.
     *
     * @param pluginName The fully-qualified name of the plugin type to apply.
     */
    public void setPluginName(@MaybeNull String pluginName) {
        this.pluginName = pluginName;
    }

    /**
     * Resolves the plugin type.
     *
     * @param classLoader The class loader to load a plugin from, if appropriate.
     * @return The loaded plugin type.
     */
    protected Class toPlugin(@MaybeNull ClassLoader classLoader) {
        if (plugin != null) {
            if (pluginName != null && !plugin.getName().equals(pluginName)) {
                throw new GradleException("Defined both plugin (" + plugin + ") and plugin name (" + pluginName + ") but they are not equal");
            }
            return plugin;
        } else if (pluginName != null) {
            try {
                @SuppressWarnings("unchecked")
                Class type = (Class) Class.forName(pluginName, false, classLoader);
                if (!Plugin.class.isAssignableFrom(type)) {
                    throw new GradleException(type.getName() + " does not implement " + Plugin.class.getName());
                }
                return type;
            } catch (ClassNotFoundException e) {
                throw new GradleException("Cannot locate plugin class " + pluginName + " by its name", e);
            }
        } else {
            throw new GradleException("No plugin or plugin name defined for transformation");
        }
    }

    /**
     * Resolves the name of the plugin.
     *
     * @return The name of the plugin.
     */
    protected String toPluginName() {
        if (plugin != null) {
            if (pluginName != null && !plugin.getName().equals(pluginName)) {
                throw new GradleException("Defined both plugin (" + plugin + ") and plugin name (" + pluginName + ") but they are not equal");
            }
            return plugin.getName();
        } else if (pluginName != null) {
            return pluginName;
        } else {
            throw new GradleException("No plugin or plugin name defined for transformation");
        }
    }
}