Resource


1   /*
2    * Copyright 2006-2007 The Scriptella Project Team.
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 scriptella.spi;
17  
18  import java.io.IOException  ;
19  import java.io.Reader  ;
20  
21  
22  /**
23   * Represents reference to a text resource capable of creating new readers.
24   *
25   * @author Fyodor Kupolov
26   * @version 1.0
27   */
28  public interface Resource {
29      /**
30       * Opens a resource and returns a content reader.
31       * <p>The returned reader implementation should be effective enough to allow usage without
32       * extra buffering, etc.
33       *
34       * @return resource content reader
35       * @throws IOException if I/O error occurs.
36       */
37      Reader   open() throws IOException  ;
38  
39      /**
40       * @return location of content or meaningful description.
41       */
42      String   toString();
43  }
44

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags