org.codehaus.groovy.control.io
[Java] Interface ReaderSource

org.codehaus.groovy.control.io.ReaderSource
  org.codehaus.groovy.control.HasCleanup

All Superinterfaces:

HasCleanup

public interface ReaderSource
extends HasCleanup

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

Authors:

Chris Poirier

Version:

\$Id\$

canReopenSource

public boolean canReopenSource()

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

Returns:

true if the resource can be reopened for reading

cleanup

public void cleanup()

Cleans up any cached resources used by getLine().

getLine

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

Parameters:

lineNumber - the number of the line of interest

janitor - helper to clean up afterwards

Returns:

the line of interest

getReader

public java.io.Reader getReader()

Returns a new Reader on the underlying source object. Returns null if the source can't be reopened.

throws:

java.io.IOException if there was an error opening for stream

Returns:

the reader to the resource

Groovy Documentation