Package org.verapdf.io

Class InternalInputStream

java.lang.Object

java.io.InputStream

org.verapdf.as.io.ASInputStream

org.verapdf.io.SeekableInputStream

org.verapdf.io.InternalInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class InternalInputStream
extends SeekableInputStream

ASInputStream for reading data from file. It contains methods for file closing management.

Author:

Timur Kamalov

Field Summary

Fields inherited from class org.verapdf.as.io.ASInputStream

isClosed, isSourceClosed, resourceUsers

Constructor Summary

Constructors

Constructor	Description
InternalInputStream(File file)
InternalInputStream(File file, boolean isTempFile)
InternalInputStream(File file, int numOfFileUsers, boolean isTempFile)
InternalInputStream(RandomAccessFile stream, long fromOffset, long size, IntReference numOfFileUsers, String filePath, boolean isTempFile)
InternalInputStream(RandomAccessFile stream, long fromOffset, long size, IntReference numOfFileUsers, String filePath, boolean isTempFile, int bufferSize)
InternalInputStream(String fileName)
InternalInputStream(String fileName, int numOfFileUsers)

Method Summary

Modifier and Type	Method	Description
void	closeResource()	Closes stream resource.
static InternalInputStream	createConcatenated(byte[] alreadyRead, InputStream stream)	Constructor writes into temp file passed buffer, then passed stream.
long	getOffset()	Gets offset of current byte.
ASInputStream	getStream(long startOffset, long length)	Gets substream of this stream that starts at given offset and has given length.
long	getStreamLength()	Gets total length of stream.
int	peek()	Gets next byte without reading it.
int	read()
int	read(byte[] buffer, int size)
void	reset()
void	seek(long offset)	Goes to a particular byte in stream.
int	skip(int size)

Methods inherited from class org.verapdf.io.SeekableInputStream

decrementResourceUsers, getSeekableStream, incrementResourceUsers, isEOF, readByte, seekFromCurrentPosition, seekFromEnd, unread, unread

Methods inherited from class org.verapdf.as.io.ASInputStream

close, createStreamFromStream

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalInputStream

public InternalInputStream(File file)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(File file,
                           boolean isTempFile)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(File file,
                           int numOfFileUsers,
                           boolean isTempFile)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(String fileName)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(String fileName,
                           int numOfFileUsers)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(RandomAccessFile stream,
                           long fromOffset,
                           long size,
                           IntReference numOfFileUsers,
                           String filePath,
                           boolean isTempFile)
                    throws IOException

Throws:

IOException

InternalInputStream

public InternalInputStream(RandomAccessFile stream,
                           long fromOffset,
                           long size,
                           IntReference numOfFileUsers,
                           String filePath,
                           boolean isTempFile,
                           int bufferSize)
                    throws IOException

Throws:

IOException

Method Detail

createConcatenated

public static InternalInputStream createConcatenated(byte[] alreadyRead,
                                                     InputStream stream)
                                              throws IOException

Constructor writes into temp file passed buffer, then passed stream. After that, InternalInputStream from file is created.

Parameters:

alreadyRead - is byte array of data that was already read from the beginning of stream.

stream - is data left in stream.

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class ASInputStream

Throws:

IOException

read

public int read(byte[] buffer,
                int size)
         throws IOException

Specified by:

read in class ASInputStream

Throws:

IOException

skip

public int skip(int size)
         throws IOException

Specified by:

skip in class ASInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Specified by:

reset in class ASInputStream

Throws:

IOException

seek

public void seek(long offset)
          throws IOException

Description copied from class: SeekableInputStream

Goes to a particular byte in stream.

Specified by:

seek in class SeekableInputStream

Parameters:

offset - is offset of a byte to go to.

Throws:

IOException

peek

public int peek()
         throws IOException

Description copied from class: SeekableInputStream

Gets next byte without reading it.

Specified by:

peek in class SeekableInputStream

Returns:

next byte.

Throws:

IOException

getOffset

public long getOffset()
               throws IOException

Description copied from class: SeekableInputStream

Gets offset of current byte.

Specified by:

getOffset in class SeekableInputStream

Returns:

offset of byte to be read next.

Throws:

IOException

getStream

public ASInputStream getStream(long startOffset,
                               long length)
                        throws IOException

Description copied from class: SeekableInputStream

Gets substream of this stream that starts at given offset and has given length.

Specified by:

getStream in class SeekableInputStream

Parameters:

startOffset - is starting offset of substream.

length - is length of substream.

Throws:

IOException

closeResource

public void closeResource()
                   throws IOException

Description copied from class: ASInputStream

Closes stream resource. There is a difference between closing stream and closing it's resource. Several streams may have the same resource (e. g. the same file stream) and resource should be closed only after all streams using it are closed.

Specified by:

closeResource in class ASInputStream

Throws:

IOException

getStreamLength

public long getStreamLength()
                     throws IOException

Description copied from class: SeekableInputStream

Gets total length of stream.

Specified by:

getStreamLength in class SeekableInputStream

Returns:

length of stream in bytes.

Throws:

IOException