com.asakusafw.runtime.io.line

Class LineInput

java.lang.Object

com.asakusafw.runtime.io.line.LineInput

All Implemented Interfaces:

ModelInput<StringOption>, Closeable, AutoCloseable

Direct Known Subclasses:

BasicLineInput, Utf8LineInput

public abstract class LineInput
extends Object
implements ModelInput<StringOption>

A simple line reader for text.

Since:

0.7.5

Constructor Summary

Constructors

Constructor and Description
LineInput()

Method Summary

Modifier and Type	Method and Description
abstract long	getLineNumber() Returns the number of lines which this object has read.
abstract String	getPath() Returns the parsing target path.
static LineInput	newInstance(InputStream stream, String path, LineConfiguration configuration) Creates a new instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.asakusafw.runtime.io.ModelInput

readTo

Methods inherited from interface java.io.Closeable

close

Constructor Detail

LineInput

public LineInput()

Method Detail

newInstance

public static LineInput newInstance(InputStream stream,
                                    String path,
                                    LineConfiguration configuration)

Creates a new instance.

Parameters:

stream - the source stream

path - the source path

configuration - the current configuration

Returns:

the created instance

Throws:

IllegalArgumentException - if some parameters were null

getPath

public abstract String getPath()

Returns the parsing target path.

Returns:

the path

getLineNumber

public abstract long getLineNumber()

Returns the number of lines which this object has read.

Returns:

the consumed number of lines