de.schlichtherle.truezip.rof

Class ReadOnlyFileInputStream

java.lang.Object

java.io.InputStream

de.schlichtherle.truezip.rof.ReadOnlyFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
 @CleanupObligation
public class ReadOnlyFileInputStream
extends InputStream

An adapter class turning a provided ReadOnlyFile into an InputStream. Note that this stream supports marking.

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadOnlyFile	rof The underlying ReadOnlyFile.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyFileInputStream(ReadOnlyFile rof) Adapts the given ReadOnlyFile.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
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

rof

@Nullable
protected ReadOnlyFile rof

The underlying ReadOnlyFile. Any of the methods in this class throw a NullPointerException if this hasn't been initialized.

Constructor Detail

ReadOnlyFileInputStream

@CreatesObligation
public ReadOnlyFileInputStream(@Nullable @WillCloseWhenClosed
                                                  ReadOnlyFile rof)

Adapts the given ReadOnlyFile.

Parameters:

rof - The underlying ReadOnlyFile. May be null, but must be initialized before any method of this class can be used.

Method Detail

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

@DischargesObligation
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

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

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

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException