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  
20  package org.apache.commons.compress.parallel;
21  
22  import java.io.InputStream;
23  
24  /**
25   * Supplies input streams.
26   *
27   * Implementations are required to support thread-handover. While an instance will not be accessed concurrently by multiple threads, it will be called by a
28   * different thread than it was created on.
29   *
30   * @since 1.10
31   */
32  public interface InputStreamSupplier {
33  
34      /**
35       * Supplies an input stream for a resource.
36       *
37       * @return the input stream. Should never be null, but may be an empty stream.
38       */
39      InputStream get();
40  }