jhelp.util.io

Class IndexedInputStream

java.lang.Object

java.io.InputStream

jhelp.util.io.IndexedInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class IndexedInputStream
extends java.io.InputStream

Input stream that you can know the reading index (Number of bytes actually read) at any time

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	finish Indicates if we are at the end of the stream
private int	index Actual index
private java.io.InputStream	inputStream Stream to read

Constructor Summary

Constructors

Constructor and Description
IndexedInputStream(java.io.InputStream inputStream) Create a new instance of IndexedInputStream

Method Summary

Methods

Modifier and Type	Method and Description
int	getCurrentIndex() Current index (Number of bytes actually read)
boolean	isFinish() Indicates if we are at the end of the stream
int	read() Read one byte on the stream Parent documentation:
int	read(byte[] b) Read some bytes on trying to fill the given array Parent documentation:
int	read(byte[] b, int off, int len) Read some byte and write them inside a given array Parent documentation:

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

finish

private boolean finish

Indicates if we are at the end of the stream

index

private int index

Actual index

inputStream

private final java.io.InputStream inputStream

Stream to read

Constructor Detail

IndexedInputStream

public IndexedInputStream(java.io.InputStream inputStream)

Create a new instance of IndexedInputStream

Parameters:

inputStream - Stream to read

Method Detail

getCurrentIndex

public int getCurrentIndex()

Current index (Number of bytes actually read)

Returns:

Current index

isFinish

public boolean isFinish()

Indicates if we are at the end of the stream

Returns:

true if we are at the end of the stream

read

public int read()
         throws java.io.IOException

Read one byte on the stream

Parent documentation:

Specified by:

read in class java.io.InputStream

Returns:

The byte read or -1 if we are at the end of the stream

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read()

read

public int read(byte[] b)
         throws java.io.IOException

Read some bytes on trying to fill the given array

Parent documentation:

Overrides:

read in class java.io.InputStream

Parameters:

b - Array to fill

Returns:

Number of bytes read or -1 if we are at the end of the stream

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read(byte[])

read

public int read(byte[] b,
       int off,
       int len)
         throws java.io.IOException

Read some byte and write them inside a given array

Parent documentation:

Overrides:

read in class java.io.InputStream

Parameters:

b - Array where write read bytes

off - Offset inside array where start write bytes

len - Number of bytes to write at maximum

Returns:

Number of bytes effectively read from stream and write to the array OR -1 if we are at the end of the stream

Throws:

java.io.IOException - On reading issue

See Also:

InputStream.read(byte[], int, int)