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.creadur.whisker.app;
20  
21  import java.io.IOException;
22  import java.io.InputStream;
23  
24  /**
25   * A resource capable of being opened as a stream.
26   */
27  public abstract class StreamableResource {
28  
29      /**
30       * Opens the resource as a stream.
31       * @return open resource, not null
32       * @throws IOException when resource cannot be opened as a stream
33       */
34      public abstract InputStream open() throws IOException;
35  }