01: /*
02: $Id: ReaderSource.java 1082 2004-04-19 07:29:47Z cpoirier $
03:
04: Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
05:
06: Redistribution and use of this software and associated documentation
07: ("Software"), with or without modification, are permitted provided
08: that the following conditions are met:
09:
10: 1. Redistributions of source code must retain copyright
11: statements and notices. Redistributions must also contain a
12: copy of this document.
13:
14: 2. Redistributions in binary form must reproduce the
15: above copyright notice, this list of conditions and the
16: following disclaimer in the documentation and/or other
17: materials provided with the distribution.
18:
19: 3. The name "groovy" must not be used to endorse or promote
20: products derived from this Software without prior written
21: permission of The Codehaus. For written permission,
22: please contact info@codehaus.org.
23:
24: 4. Products derived from this Software may not be called "groovy"
25: nor may "groovy" appear in their names without prior written
26: permission of The Codehaus. "groovy" is a registered
27: trademark of The Codehaus.
28:
29: 5. Due credit should be given to The Codehaus -
30: http://groovy.codehaus.org/
31:
32: THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33: ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34: NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35: FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
36: THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43: OF THE POSSIBILITY OF SUCH DAMAGE.
44:
45: */
46:
47: package org.codehaus.groovy.control.io;
48:
49: import java.io.IOException;
50: import java.io.Reader;
51:
52: import org.codehaus.groovy.control.HasCleanup;
53: import org.codehaus.groovy.control.Janitor;
54:
55: /**
56: * An interface for things that can supply (and resupply) a Reader
57: * on a source stream.
58: *
59: * @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
60: *
61: * @version $Id: ReaderSource.java 1082 2004-04-19 07:29:47Z cpoirier $
62: */
63:
64: public interface ReaderSource extends HasCleanup {
65:
66: /**
67: * Returns a new Reader on the underlying source object. Returns
68: * null if the source can't be reopened.
69: */
70:
71: Reader getReader() throws IOException;
72:
73: /**
74: * Returns true if the source can be restarted (ie. if getReader()
75: * will return non-null on subsequent calls.
76: */
77:
78: boolean canReopenSource();
79:
80: /**
81: * Returns a line from the source, or null, if unavailable. If
82: * you supply a Janitor, resources will be cached.
83: */
84:
85: String getLine(int lineNumber, Janitor janitor);
86:
87: /**
88: * Cleans up any cached resources used by getLine().
89: */
90:
91: void cleanup();
92:
93: }
|