org.codehaus.groovy.control.io
Class AbstractReaderSource

java.lang.Object
  extended by org.codehaus.groovy.control.io.AbstractReaderSource
All Implemented Interfaces:
HasCleanup, ReaderSource
Direct Known Subclasses:
FileReaderSource, InputStreamReaderSource, StringReaderSource, URLReaderSource

public abstract class AbstractReaderSource
extends Object
implements ReaderSource

For ReaderSources that can choose a parent class, a base that provides common functionality.

Version:
$Id: AbstractReaderSource.java,v 1.2 2005/06/19 15:41:38 cstein Exp $
Author:
Chris Poirier

Field Summary
protected  CompilerConfiguration configuration
           
 
Constructor Summary
AbstractReaderSource(CompilerConfiguration configuration)
          Standard construction stuff.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.codehaus.groovy.control.io.ReaderSource
getReader
 

Field Detail

configuration

protected CompilerConfiguration configuration
Constructor Detail

AbstractReaderSource

public AbstractReaderSource(CompilerConfiguration configuration)
Standard construction stuff.

Method Detail

canReopenSource

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

Specified by:
canReopenSource in interface ReaderSource

getLine

public 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.

Specified by:
getLine in interface ReaderSource

cleanup

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

Specified by:
cleanup in interface HasCleanup
Specified by:
cleanup in interface ReaderSource


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