View Javadoc
1   package org.apache.maven.plugins.shade.resource;
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.plugins.shade.relocation.Relocator;
23  
24  import java.io.IOException;
25  import java.io.InputStream;
26  import java.util.List;
27  
28  /**
29   * Transform resource ensuring reproducible output: that requires to get the timestamp of
30   * the initial resources to define in a reproducible way the timestamp of the transformed
31   * resource.
32   *
33   * @author Hervé Boutemy
34   * @since 3.2.4
35   */
36  public interface ReproducibleResourceTransformer
37      extends ResourceTransformer
38  {
39      /**
40       * Transform an individual resource
41       * @param resource The resource name
42       * @param is An input stream for the resource, the implementation should *not* close this stream
43       * @param relocators  A list of relocators
44       * @param time the time of the resource to process
45       * @throws IOException When the IO blows up
46       */
47      void processResource( String resource, InputStream is, List<Relocator> relocators, long time )
48          throws IOException;
49  }