1 package org.codehaus.plexus.components.io.functions;
2
3 /*
4 * Copyright 2014 The Codehaus Foundation.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * 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, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 import javax.annotation.Nonnull;
19
20 import java.io.IOException;
21 import java.io.InputStream;
22
23 import org.codehaus.plexus.components.io.resources.PlexusIoResource;
24
25 /**
26 * Transform a stream into some other kind of stream. May be used to apply filtering or other
27 * kinds of transformations.
28 */
29 public interface InputStreamTransformer {
30 /**
31 * Transform the supplied input stream into another input stream.
32 * <p>
33 * The close method will be delegated through the entire call chain
34 *
35 * @param resource The p-io resource the stream is for
36 * @param inputStream The stream to transform
37 * @return A transformed stream or possibly the supplied stream
38 * @throws IOException
39 */
40 @Nonnull
41 InputStream transform(@Nonnull PlexusIoResource resource, @Nonnull InputStream inputStream) throws IOException;
42 }