Package com.illumon.iris.importers.util

Class SkipLinesInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.BufferedInputStream

com.illumon.iris.importers.util.SkipLinesInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SkipLinesInputStream
extends BufferedInputStream

SkipLinesInputStream adds functionality to another InputStream namely the ability to skip header or footer lines. The class maintains a queue of up to skip footer lines, popping a line on request only if there is more data to be read in the input stream. The logic is only used if skip footer lines has a value greater than 0.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_BUFFER_SIZE
protected static final int	EOF
protected static final int	LINE_BUFFER_SIZE

Fields inherited from class java.io.BufferedInputStream

buf, count, marklimit, markpos, pos

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
SkipLinesInputStream(InputStream in, int skipHeaderLines, int skipFooterLines)	Creates SkipLinesInputStream wrapper around given InputStream.
SkipLinesInputStream(InputStream in, int skipHeaderLines, int skipFooterLines, int bufferSize)	Creates SkipLinesInputStream wrapper around given InputStream using specified buffer size.

Method Summary

Modifier and Type	Method	Description
int	available()
int	getBufferSize()
static int	getDefaultBufferSize()
int	read()
int	read(byte[] b, int off, int len)
String	readLine()	Returns the next available line from the stream as String.
String	readLine(boolean ignoreLineBreakCharacters)	If the ignoreLineBreakCharacters parameter is true the next available line will be returned without CR or LF or CRLF characters.
protected void	readLineAsBytes(gnu.trove.list.array.TByteArrayList line)	Returns the next available line from the stream as bytes populated in TByteArrayList.
void	reset()
long	skip(long n)

Methods inherited from class java.io.BufferedInputStream

close, mark, markSupported

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUFFER_SIZE

protected static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

EOF

protected static final int EOF

See Also:

• Constant Field Values

LINE_BUFFER_SIZE

protected static final int LINE_BUFFER_SIZE

See Also:

• Constant Field Values

Constructor Details

SkipLinesInputStream

public SkipLinesInputStream(InputStream in,
 int skipHeaderLines,
 int skipFooterLines)
                     throws IOException

Creates SkipLinesInputStream wrapper around given InputStream.

Parameters:

in - The underlying InputStream

skipHeaderLines - Number of lines to skip at the beginning

skipFooterLines - Number of line to skip from end of stream

Throws:

IOException

SkipLinesInputStream

public SkipLinesInputStream(InputStream in,
 int skipHeaderLines,
 int skipFooterLines,
 int bufferSize)
                     throws IOException

Creates SkipLinesInputStream wrapper around given InputStream using specified buffer size.

Parameters:

in - The underlying InputStream

skipHeaderLines - Number of lines to skip at the beginning

skipFooterLines - Number of line to skip from end of stream

bufferSize - BufferSize used by parent BufferedInputStream

Throws:

IOException

Method Details

getBufferSize

public int getBufferSize()

getDefaultBufferSize

public static int getDefaultBufferSize()

read

public int read()
         throws IOException

Overrides:

read in class BufferedInputStream

Throws:

IOException

read

public int read(@NotNull
 byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class BufferedInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class BufferedInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class BufferedInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class BufferedInputStream

Throws:

IOException

readLine

public String readLine(boolean ignoreLineBreakCharacters)
                throws IOException

If the ignoreLineBreakCharacters parameter is true the next available line will be returned without CR or LF or CRLF characters. If ignoreLineBreakCharacters parameter is false returns the next available line from the stream as String. A line is determined by CR, LF or CRLF. In case of a CR the next byte is looked up and if it is LF then returned line includes up to LF, otherwise up to CR. The next byte is then the first byte to be read next.

Parameters:

ignoreLineBreakCharacters - indicates if the returned String should include the CR / LF or CRLF characters

Throws:

IOException

readLine

public String readLine()
                throws IOException

Returns the next available line from the stream as String. A line is determined by CR, LF or CRLF. In case of a CR the next byte is looked up and if it is LF then returned line includes up to LF, otherwise up to CR. The next byte is then the first byte to be read next.

Throws:

IOException

readLineAsBytes

protected void readLineAsBytes(gnu.trove.list.array.TByteArrayList line)
                        throws IOException

Returns the next available line from the stream as bytes populated in TByteArrayList. A line is determined by CR, LF or CRLF. In case of a CR the next byte is looked up and if it is LF then returned line includes up to LF, otherwise up to CR. The next byte is then the first byte to be read next.

Parameters:

line - TByteArrayList that holds the byte array of the next line.

Throws:

IOException