LineUtil (commons-io 1.2.18 API)

java.lang.Object
- de.unkrig.commons.io.LineUtil

```
public final class LineUtil
extends Object
```
Various utility methods for processing "lines", i.e. sequences of strings (which typically don't contain line breaks).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LineUtil.LineAndColumnTracker
Keeps track of "line numbers" and "column numbers" while it consumes a stream of chars.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LineUtil.LineAndColumnTracker` Keeps track of "line numbers" and "column numbers" while it `consumes` a stream of `char`s.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static LineUtil.LineAndColumnTracker`	`lineAndColumnTracker()` Creates a `LineUtil.LineAndColumnTracker` which implements line and column counting.
`static Consumer<String>`	`lineConsumer(PrintStream ps)` Prints the consumed strings as lines to the given `PrintStream`.
`static <T extends CharSequence> Consumer<T>`	`lineConsumer(PrintWriter pw)` Prints the consumed strings as lines to the given `PrintWriter`.
`static ConsumerWhichThrows<String,IOException>`	`lineConsumer(Writer w)` Writes the consumed strings as lines to the given `Writer`.
`static ConsumerWhichThrows<String,IOException>`	`lineConsumerISO8859_1(OutputStream out)` Writes the consumed strings as lines to the ISO 8859-1-encoded `OutputStream`.
`static Producer<CharSequence>`	`lineProducer(CharSequence text)` Produces lines from a CharSequence by splitting that at line breaks.
`static ProducerWhichThrows<String,IOException>`	`lineProducer(Reader r)` Produces lines from a `Reader`.
`static Producer<String>`	`lineProducer(String text)` Produces lines from a string by splitting that at line breaks.
`static ProducerWhichThrows<String,IOException>`	`lineProducerISO8859_1(InputStream in)` Produces lines from a ISO 8859-1-encoded `InputStream`.
`static List<String>`	`readAllLines(Reader r, boolean closeReader)` Reads lines from the given reader until end-of-input.
`static ProducerWhichThrows<String,IOException>`	`readLineWithSeparator(Reader r)` Similar to `BufferedReader.readLine()`, except that The produced strings include the line separator Not only CR, LF and CRLF are recognized as line terminators, but also some other special characters, as described here

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - lineProducerISO8859_1
```
public static ProducerWhichThrows<String,IOException> lineProducerISO8859_1(InputStream in)
```
    Produces lines from a ISO 8859-1-encoded InputStream.
  - lineProducer
```
public static ProducerWhichThrows<String,IOException> lineProducer(Reader r)
```
    Produces lines from a Reader.
  - lineProducer
```
public static Producer<String> lineProducer(String text)
```
    Produces lines from a string by splitting that at line breaks.
  - lineProducer
```
public static Producer<CharSequence> lineProducer(CharSequence text)
```
    Produces lines from a CharSequence by splitting that at line breaks.
  - readLineWithSeparator
```
public static ProducerWhichThrows<String,IOException> readLineWithSeparator(Reader r)
```
    Similar to BufferedReader.readLine(), except that
    - The produced strings include the line separator
    - Not only CR, LF and CRLF are recognized as line terminators, but also some other special characters, as described here
    Parameters:
    
    r - The source of characters
    
    Returns:
    
    Produces one string for each parsed line and null at end-of-input
  - lineConsumerISO8859_1
```
public static ConsumerWhichThrows<String,IOException> lineConsumerISO8859_1(OutputStream out)
```
    Writes the consumed strings as lines to the ISO 8859-1-encoded OutputStream.
  - lineConsumer
```
public static ConsumerWhichThrows<String,IOException> lineConsumer(Writer w)
```
    Writes the consumed strings as lines to the given Writer.
  - lineConsumer
```
public static <T extends CharSequence> Consumer<T> lineConsumer(PrintWriter pw)
```
    Prints the consumed strings as lines to the given PrintWriter.
  - lineConsumer
```
public static Consumer<String> lineConsumer(PrintStream ps)
```
    Prints the consumed strings as lines to the given PrintStream.
  - readAllLines
```
public static List<String> readAllLines(Reader r,
                                        boolean closeReader)
                                 throws IOException
```
    Reads lines from the given reader until end-of-input.
    
    Throws:
    
    IOException
  - lineAndColumnTracker
```
public static LineUtil.LineAndColumnTracker lineAndColumnTracker()
```
    Creates a LineUtil.LineAndColumnTracker which implements line and column counting.
    Line breaks are identified as defined by the \R pattern of Pattern.
    
    Initially, line number and column number are both 1. Line breaks increment the line and reset the column to 1. TAB characters increase the column to the nearest multiple of the TAB width. All other characters increment the column.

Class LineUtil

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

lineProducerISO8859_1

lineProducer

lineProducer

lineProducer

readLineWithSeparator

lineConsumerISO8859_1

lineConsumer

lineConsumer

lineConsumer

readAllLines

lineAndColumnTracker