Package org.codehaus.groovy.control.io
Class AbstractReaderSource
- java.lang.Object
- 
- org.codehaus.groovy.control.io.AbstractReaderSource
 
- 
- All Implemented Interfaces:
- HasCleanup,- ReaderSource
 - Direct Known Subclasses:
- FileReaderSource,- InputStreamReaderSource,- StringReaderSource,- URLReaderSource
 
 public abstract class AbstractReaderSource extends java.lang.Object implements ReaderSource For ReaderSources that can choose a parent class, a base that provides common functionality.
- 
- 
Field SummaryFields Modifier and Type Field Description protected CompilerConfigurationconfiguration
 - 
Constructor SummaryConstructors Constructor Description AbstractReaderSource(CompilerConfiguration configuration)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanReopenSource()Returns true if the source can be restarted (ie.voidcleanup()Cleans up any cached resources used by getLine().java.lang.StringgetLine(int lineNumber, Janitor janitor)Returns a line from the source, or null, if unavailable.- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface org.codehaus.groovy.control.io.ReaderSourcegetReader, getURI
 
- 
 
- 
- 
- 
Field Detail- 
configurationprotected CompilerConfiguration configuration 
 
- 
 - 
Constructor Detail- 
AbstractReaderSourcepublic AbstractReaderSource(CompilerConfiguration configuration) 
 
- 
 - 
Method Detail- 
canReopenSourcepublic boolean canReopenSource() Returns true if the source can be restarted (ie. if getReader() will return non-null on subsequent calls.- Specified by:
- canReopenSourcein interface- ReaderSource
- Returns:
- true if the resource can be reopened for reading
 
 - 
getLinepublic java.lang.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:
- getLinein interface- ReaderSource
- Parameters:
- lineNumber- the number of the line of interest
- janitor- helper to clean up afterwards
- Returns:
- the line of interest
 
 - 
cleanuppublic void cleanup() Cleans up any cached resources used by getLine().- Specified by:
- cleanupin interface- HasCleanup
- Specified by:
- cleanupin interface- ReaderSource
 
 
- 
 
-