KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > codehaus > groovy > control > io > ReaderSource


1 /*
2  $Id: ReaderSource.java,v 1.1 2004/04/19 07:29:44 cpoirier Exp $
3
4  Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5
6  Redistribution and use of this software and associated documentation
7  ("Software"), with or without modification, are permitted provided
8  that the following conditions are met:
9
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 JavaDoc;
50 import java.io.Reader JavaDoc;
51
52 import org.codehaus.groovy.control.HasCleanup;
53 import org.codehaus.groovy.control.Janitor;
54
55
56 /**
57  * An interface for things that can supply (and resupply) a Reader
58  * on a source stream.
59  *
60  * @author <a HREF="mailto:cpoirier@dreaming.org">Chris Poirier</a>
61  *
62  * @version $Id: ReaderSource.java,v 1.1 2004/04/19 07:29:44 cpoirier Exp $
63  */
64
65 public interface ReaderSource extends HasCleanup
66 {
67    
68    /**
69     * Returns a new Reader on the underlying source object. Returns
70     * null if the source can't be reopened.
71     */
72     
73     Reader JavaDoc getReader() throws IOException JavaDoc;
74     
75     
76     
77    /**
78     * Returns true if the source can be restarted (ie. if getReader()
79     * will return non-null on subsequent calls.
80     */
81     
82     boolean canReopenSource();
83     
84     
85     
86    /**
87     * Returns a line from the source, or null, if unavailable. If
88     * you supply a Janitor, resources will be cached.
89     */
90     
91     String JavaDoc getLine( int lineNumber, Janitor janitor );
92     
93     
94     
95    /**
96     * Cleans up any cached resources used by getLine().
97     */
98     
99     void cleanup();
100     
101 }
102
Popular Tags