org.apache.nifi.stream.io.util

Class LineDemarcator

java.lang.Object

org.apache.nifi.stream.io.util.AbstractTextDemarcator

org.apache.nifi.stream.io.util.LineDemarcator

All Implemented Interfaces:

Closeable, AutoCloseable

public class LineDemarcator
extends AbstractTextDemarcator

A demarcator that scans an InputStream for line endings (carriage returns and new lines) and returns lines of text one-at-a-time. This is similar to BufferedReader but with a very important distinction: while BufferedReader returns the lines of text after stripping off any line endings, this class returns text including the line endings. So, for example, if the following text is provided: ABC\rXYZ\nABCXYZ\r\nhello Then calls to nextLine() will result in 4 String values being returned:

• ABC\r
• XYZ\n
• ABCXYZ\r\n
• hello

All subsequent calls to nextLine() will return null.

Field Summary

Fields

Modifier and Type	Field and Description
private static char	CARRIAGE_RETURN
private char	lastChar
private static char	NEW_LINE

Fields inherited from class org.apache.nifi.stream.io.util.AbstractTextDemarcator

availableBytesLength, buffer, index, mark

Constructor Summary

Constructors

Constructor and Description
LineDemarcator(InputStream in, Charset charset, int maxDataSize, int initialBufferSize)
LineDemarcator(Reader reader, int maxDataSize, int initialBufferSize)

Method Summary

Modifier and Type	Method and Description
String	nextLine() Will read the next line of text from the InputStream returning null when it reaches the end of the stream.

Methods inherited from class org.apache.nifi.stream.io.util.AbstractTextDemarcator

close, fill

Methods inherited from class java.lang.Object

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

Field Detail

CARRIAGE_RETURN

private static final char CARRIAGE_RETURN

See Also:

Constant Field Values

NEW_LINE

private static final char NEW_LINE

See Also:

Constant Field Values

lastChar

private char lastChar

Constructor Detail

LineDemarcator

public LineDemarcator(InputStream in,
                      Charset charset,
                      int maxDataSize,
                      int initialBufferSize)

LineDemarcator

public LineDemarcator(Reader reader,
                      int maxDataSize,
                      int initialBufferSize)

Method Detail

nextLine

public String nextLine()
                throws IOException

Will read the next line of text from the InputStream returning null when it reaches the end of the stream.

Throws:

IOException - if unable to read from the stream