AbstractReaderSource (Groovy 1.8.4)

Overview

Package

Class

Deprecated

Index

Help

Groovy 1.8.4

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.control.io
[Java] Class AbstractReaderSource

java.lang.Object
  org.codehaus.groovy.control.io.AbstractReaderSource

public abstract class AbstractReaderSource
extends Object

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

Field Summary
`protected CompilerConfiguration`	`configuration`

Constructor Summary
`AbstractReaderSource(CompilerConfiguration configuration)`

Method Summary
`boolean`	`canReopenSource()` Returns true if the source can be restarted (ie. if getReader() will return non-null on subsequent calls.
`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 Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

Field Detail

protected CompilerConfiguration configuration

Constructor Detail

public AbstractReaderSource(CompilerConfiguration configuration)

Method Detail

public boolean canReopenSource()

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

public void cleanup()

Cleans up any cached resources used by 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.