1 package org.apache.maven.plugins.shade;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.plugin.MojoExecutionException;
23 import org.apache.maven.plugins.shade.filter.Filter;
24 import org.apache.maven.plugins.shade.relocation.Relocator;
25 import org.apache.maven.plugins.shade.resource.ResourceTransformer;
26
27 import java.io.File;
28 import java.io.IOException;
29 import java.util.List;
30 import java.util.Set;
31
32 /**
33 * Interface that defines the process of shading.
34 */
35 public interface Shader
36 {
37 String ROLE = Shader.class.getName();
38
39 /**
40 * Perform a shading operation.
41 *
42 * @param jars which jars
43 * @param uberJar output jar
44 * @param filters the filters
45 * @param relocators the relocators
46 * @param resourceTransformers the transformers
47 * @throws IOException for IO errors reading the thing
48 * @throws MojoExecutionException for anything else that goes wrong.
49 */
50 void shade( Set<File> jars, File uberJar, List<Filter> filters, List<Relocator> relocators,
51 List<ResourceTransformer> resourceTransformers )
52 throws IOException, MojoExecutionException;
53 }