com.asakusafw.runtime.io.line

Class BasicLineInput

java.lang.Object

com.asakusafw.runtime.io.line.LineInput

com.asakusafw.runtime.io.line.BasicLineInput

All Implemented Interfaces:

ModelInput<StringOption>, Closeable, AutoCloseable

public class BasicLineInput
extends LineInput

A simple line reader for text with any charset encoding.

Since:

0.7.5

Constructor Summary

Constructors

Constructor and Description
BasicLineInput(InputStream stream, String path, LineConfiguration configuration) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
long	getLineNumber() Returns the number of lines which this object has read.
String	getPath() Returns the parsing target path.
boolean	readTo(StringOption model) Reads contents and write them into the target data model object.

Methods inherited from class com.asakusafw.runtime.io.line.LineInput

newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicLineInput

public BasicLineInput(InputStream stream,
                      String path,
                      LineConfiguration configuration)

Creates a new instance.

Parameters:

stream - the source stream

path - the source path

configuration - the current configuration

Throws:

IllegalArgumentException - if some parameters were null

See Also:

LineInput.newInstance(InputStream, String, LineConfiguration)

Method Detail

getPath

public String getPath()

Description copied from class: LineInput

Returns the parsing target path.

Specified by:

getPath in class LineInput

Returns:

the path

getLineNumber

public long getLineNumber()

Description copied from class: LineInput

Returns the number of lines which this object has read.

Specified by:

getLineNumber in class LineInput

Returns:

the consumed number of lines

readTo

public boolean readTo(StringOption model)
               throws IOException

Description copied from interface: ModelInput

Reads contents and write them into the target data model object. The target data model object will be changed even if the next data does not exist.

Parameters:

model - the target data model object

Returns:

true if the next data was successfully read, or false if there is no any more

Throws:

IOException - if error occurred while reading the next data

close

public void close()
           throws IOException

Throws:

IOException