wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/io/InputResource.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.io;
  17
  18 import java.io.IOException;
  19 import java.io.InputStream;
  20
  21 /**
  22  * Represents a resource from which information can be read.
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public interface InputResource {
  27     /**
  28      * Gets the input stream to the resource. The obtained input stream must be
  29      * closed once reading has finished.
  30      *
  31      * @return Input stream to the resource, never null.
  32      *
  33      * @throws IOException
  34      *             in case the resource cannot be found.
  35      */
  36     InputStream getInputStream() throws IOException;
  37 }