01: /*
02: * Copyright 2006-2007 The Scriptella Project Team.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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: * Represents reference to a text resource capable of creating new readers.
23: *
24: * @author Fyodor Kupolov
25: * @version 1.0
26: */
27: public interface Resource {
28: /**
29: * Opens a resource and returns a content reader.
30: * <p>The returned reader implementation should be effective enough to allow usage without
31: * extra buffering, etc.
32: *
33: * @return resource content reader
34: * @throws IOException if I/O error occurs.
35: */
36: Reader open() throws IOException;
37:
38: /**
39: * @return location of content or meaningful description.
40: */
41: String toString();
42: }
|