View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.shade.resource;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  import java.util.List;
24  import java.util.jar.JarOutputStream;
25  
26  import org.apache.maven.plugins.shade.relocation.Relocator;
27  
28  /** @author Jason van Zyl */
29  public interface ResourceTransformer {
30      boolean canTransformResource(String resource);
31  
32      /**
33       * Transform an individual resource
34       * @param resource The resource name
35       * @param is An input stream for the resource, the implementation should *not* close this stream
36       * @param relocators  A list of relocators
37       * @throws IOException When the IO blows up
38       * @deprecated prefer ReproducibleResourceTransformer
39       */
40      void processResource(String resource, InputStream is, List<Relocator> relocators) throws IOException;
41  
42      boolean hasTransformedResource();
43  
44      void modifyOutputStream(JarOutputStream os) throws IOException;
45  }