org.apache.maven.plugins.shade.Shader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-shade-plugin Show documentation

Repackages the project classes together with their dependencies into a single uber-jar, optionally renaming classes or removing unused classes.

There is a newer version: 3.6.0

Show newest version

package org.apache.maven.plugins.shade;

/*
 * 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.
 */

import java.io.IOException;

import org.apache.maven.plugin.MojoExecutionException;

/**
 * Interface that defines the process of shading.
 */
public interface Shader
{
    String ROLE = Shader.class.getName();

    /**
     * Perform a shading operation.
     *
     * @param shadeRequest            holds the many parameters to this method
     * @throws IOException            for IO errors reading the thing
     * @throws MojoExecutionException for anything else that goes wrong.
     */
    void shade( ShadeRequest shadeRequest )
        throws IOException, MojoExecutionException;
}