View Javadoc
1   package org.codehaus.plexus.util.io;
2   
3   /*
4    * Copyright 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  
19  import java.io.IOException;
20  import java.io.InputStream;
21  
22  /**
23   * Interface of a wrapper for input streams. This facade is used by methods, which are being implemented for files,
24   * URL's, or input streams.
25   */
26  public interface InputStreamFacade
27  {
28      /**
29       * Retrieves the actual {@link InputStream}. The caller must assume, that this method may be invoked only once.
30       */
31      InputStream getInputStream()
32          throws IOException;
33  }