Class RandomAccessInputStream

java.lang.Object

java.io.InputStream

org.archive.io.SeekInputStream

org.archive.io.RandomAccessInputStream

All Implemented Interfaces:

RepositionableStream, Closeable, AutoCloseable

public class RandomAccessInputStream
extends SeekInputStream

Wraps a RandomAccessFile with an InputStream interface.

Author:

gojomo

Constructor Summary

Constructors

Constructor	Description
RandomAccessInputStream(File file)	Constructor.
RandomAccessInputStream(File file, long offset)	Constructor.
RandomAccessInputStream(RandomAccessFile raf)	Constructor.
RandomAccessInputStream(RandomAccessFile raf, boolean sympathyClose, long offset)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readlimit)	Marks the current position of the stream.
boolean	markSupported()	Returns true, since SeekInputStreams support mark/reset by default.
long	position()	Returns the current stream position.
void	position(long position)	Sets the current stream position.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()	Resets this stream to its marked position.
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Details

RandomAccessInputStream

public RandomAccessInputStream(RandomAccessFile raf)
                        throws IOException

Constructor. If using this constructor, caller created the RAF and therefore its assumed wants to control close of the RAF. The RAF.close is not called if this constructor is used on close of this stream.

Parameters:

raf - RandomAccessFile to wrap.

Throws:

IOException

RandomAccessInputStream

public RandomAccessInputStream(File file)
                        throws IOException

Constructor.

Parameters:

file - File to get RAFIS on. Creates an RAF from passed file. Closes the created RAF when this stream is closed.

Throws:

IOException

RandomAccessInputStream

public RandomAccessInputStream(File file,
 long offset)
                        throws IOException

Constructor.

Parameters:

file - File to get RAFIS on. Creates an RAF from passed file. Closes the created RAF when this stream is closed.

offset -

Throws:

IOException

RandomAccessInputStream

public RandomAccessInputStream(RandomAccessFile raf,
 boolean sympathyClose,
 long offset)
                        throws IOException

Parameters:

raf - RandomAccessFile to wrap.

sympathyClose - Set to true if we are to close the RAF file when this stream is closed.

offset -

Throws:

IOException

Method Details

read

public int read()
         throws IOException

Specified by:

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

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

position

public long position()
              throws IOException

Description copied from interface: RepositionableStream

Returns the current stream position.

Returns:

the current stream position.

Throws:

IOException

position

public void position(long position)
              throws IOException

Description copied from interface: RepositionableStream

Sets the current stream position.

Parameters:

position - the new stream position.

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Description copied from class: SeekInputStream

Returns true, since SeekInputStreams support mark/reset by default.

Overrides:

markSupported in class SeekInputStream

Returns:

true

mark

public void mark(int readlimit)

Description copied from class: SeekInputStream

Marks the current position of the stream. The limit parameter is ignored; the mark will remain valid until reset is called or the stream is closed.

Overrides:

mark in class SeekInputStream

Parameters:

readlimit - ignored

reset

public void reset()
           throws IOException

Description copied from class: SeekInputStream

Resets this stream to its marked position.

Overrides:

reset in class SeekInputStream

Throws:

IOException - if there is no mark, or if an IO error occurs

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException