org.unix4j.io

Class StringInput

java.lang.Object

org.unix4j.io.StringInput

All Implemented Interfaces:

AutoCloseable, Iterable<Line>, Input

public class StringInput
extends Object
implements Input

Input device reading the input from a string. If the string contains line-ending code (UNIX or DOS), it is split into multiple lines.

Constructor Summary

Constructors

Constructor and Description
StringInput(Iterable<? extends String> lines) Constructor with lines.
StringInput(Iterator<? extends String> lines) Constructor with lines.
StringInput(Stream<? extends String> lines) Constructor with lines.
StringInput(String... lines) Constructor with lines.

Method Summary

Modifier and Type	Method and Description
void	close() Close underlying resources if any, as for instance the source file.
boolean	hasMoreLines() Returns true if there are more lines to be read.
Iterator<Line>	iterator() Returns an immutable iterator over all lines returned by this input object.
Line	readLine() Reads the next line.
String	toMultilineString()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StringInput

public StringInput(String... lines)

Constructor with lines. Each line is tested for new line characters and possibly split into multiple lines.

Parameters:

lines - the lines for this input

StringInput

public StringInput(Iterable<? extends String> lines)

Constructor with lines. Each line is tested for new line characters and possibly split into multiple lines.

Parameters:

lines - the lines for this input

StringInput

public StringInput(Stream<? extends String> lines)

Constructor with lines. Each line is tested for new line characters and possibly split into multiple lines.

Parameters:

lines - the lines for this input

StringInput

public StringInput(Iterator<? extends String> lines)

Constructor with lines. Each line is tested for new line characters and possibly split into multiple lines.

Parameters:

lines - the lines for this input

Method Detail

hasMoreLines

public boolean hasMoreLines()

Description copied from interface: Input

Returns true if there are more lines to be read.

Specified by:

hasMoreLines in interface Input

Returns:

true if more lines exist

readLine

public Line readLine()

Description copied from interface: Input

Reads the next line. Returns null if no next line exists.

Specified by:

readLine in interface Input

Returns:

the next line, or null if no next line exists.

iterator

public Iterator<Line> iterator()

Description copied from interface: Input

Returns an immutable iterator over all lines returned by this input object.

Specified by:

iterator in interface Iterable<Line>

Specified by:

iterator in interface Input

Returns:

an immutable line iterator

close

public void close()

Description copied from interface: Input

Close underlying resources if any, as for instance the source file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Input

toString

public String toString()

Overrides:

toString in class Object

toMultilineString

public String toMultilineString()