org.codehaus.groovy.control.io
Interface ReaderSource

All Superinterfaces:
HasCleanup
All Known Implementing Classes:
AbstractReaderSource, FileReaderSource, InputStreamReaderSource, StringReaderSource, URLReaderSource

public interface ReaderSource
extends HasCleanup

An interface for things that can supply (and resupply) a Reader on a source stream.

Version:
$Id: ReaderSource.java 1082 2004-04-19 07:29:47Z cpoirier $
Author:
Chris Poirier

Method Summary
 boolean canReopenSource()
          Returns true if the source can be restarted (ie.
 void cleanup()
          Cleans up any cached resources used by getLine().
 String getLine(int lineNumber, Janitor janitor)
          Returns a line from the source, or null, if unavailable.
 Reader getReader()
          Returns a new Reader on the underlying source object.
 

Method Detail

getReader

Reader getReader()
                 throws IOException
Returns a new Reader on the underlying source object. Returns null if the source can't be reopened.

Throws:
IOException

canReopenSource

boolean canReopenSource()
Returns true if the source can be restarted (ie. if getReader() will return non-null on subsequent calls.


getLine

String getLine(int lineNumber,
               Janitor janitor)
Returns a line from the source, or null, if unavailable. If you supply a Janitor, resources will be cached.


cleanup

void cleanup()
Cleans up any cached resources used by getLine().

Specified by:
cleanup in interface HasCleanup


Copyright © 2003-2009 The Codehaus. All Rights Reserved.