pro.fessional.mirana.io

Class CircleInputStream

java.lang.Object

java.io.InputStream

pro.fessional.mirana.io.CircleInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class CircleInputStream
extends InputStream

 For special needs, not thread-safe, use with care, especially use mark, reset properly.

 Uses byte[] to cache the read stream, and if read again after the stream is read out, i.e. -1,
 the read will auto start from the beginning of the cache (re-available)

 Optimized only for ByteArrayInputStream and FileInputStream constructed from files.
 Other Streams, will cache all read content, need to pay attention to memory consumption.
 

Since:

2020-09-25

Author:

trydofor

See Also:

NonCloseStream

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull InputStream	backend
protected ByteArrayOutputStream	caching
protected byte[]	content
protected File	file
protected int	length
protected int	offset

Constructor Summary

Constructors

Constructor and Description
CircleInputStream(byte[] cache)
CircleInputStream(byte[] cache, int offset, int length)
CircleInputStream(@NotNull ByteArrayOutputStream cache)
CircleInputStream(@NotNull File file)
CircleInputStream(@NotNull InputStream backend)

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
byte[]	getContent()
File	getFile()
boolean	isFinished() Whether read out the stream (-1) at this time.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Field Detail

backend

@NotNull
protected @NotNull InputStream backend

caching

protected ByteArrayOutputStream caching

file

protected File file

content

protected byte[] content

offset

protected int offset

length

protected int length

Constructor Detail

CircleInputStream

public CircleInputStream(@NotNull
                         @NotNull InputStream backend)

CircleInputStream

public CircleInputStream(@NotNull
                         @NotNull File file)

CircleInputStream

public CircleInputStream(@NotNull
                         @NotNull ByteArrayOutputStream cache)

CircleInputStream

public CircleInputStream(byte[] cache)

CircleInputStream

public CircleInputStream(byte[] cache,
                         int offset,
                         int length)

Method Detail

isFinished

public boolean isFinished()

Whether read out the stream (-1) at this time.

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

getContent

public byte[] getContent()

getFile

public File getFile()