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 java.io.IOException;
23
24 import org.apache.maven.plugin.MojoExecutionException;
25
26 /**
27 * Interface that defines the process of shading.
28 */
29 public interface Shader
30 {
31 String ROLE = Shader.class.getName();
32
33 /**
34 * Perform a shading operation.
35 *
36 * @param shadeRequest holds the many parameters to this method
37 * @throws IOException for IO errors reading the thing
38 * @throws MojoExecutionException for anything else that goes wrong.
39 */
40 void shade( ShadeRequest shadeRequest )
41 throws IOException, MojoExecutionException;
42 }