org.verapdf.as.io

Class ASFileInStream

java.lang.Object

java.io.InputStream

org.verapdf.as.io.ASInputStream

org.verapdf.as.io.ASFileInStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ASFileInStream
extends ASInputStream

Class for getting a stream as a part of a file without copying a file.

Author:

Timur Kamalov

Field Summary

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

isClosed, isSourceClosed, resourceUsers

Constructor Summary

Constructors

Constructor and Description
ASFileInStream(RandomAccessFile stream, long offset, long size, IntReference numOfFileUsers, String filePath, boolean isTempFile) Creates ASFileInStream that is a substream of RandomAccessFile stream.

Method Summary

Modifier and Type	Method and Description
void	closeResource() Closes stream resource.
void	decrementResourceUsers() Method decrements number of resource users.
String	getFilePath()
void	incrementResourceUsers() Method increments number of resource users.
int	read()
int	read(byte[] buffer, int sizeToRead)
void	reset()
int	skip(int size)

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

close, createStreamFromStream

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ASFileInStream

public ASFileInStream(RandomAccessFile stream,
                      long offset,
                      long size,
                      IntReference numOfFileUsers,
                      String filePath,
                      boolean isTempFile)

Creates ASFileInStream that is a substream of RandomAccessFile stream.

Parameters:

stream - is file stream.

offset - is the offset ot the beginning of data.

size - is the length of data chunk.

numOfFileUsers - is amount of streams that use the passed RandomAccessFile as a resource. It helps to determine when the file stream should be closed.

filePath - is the path to file that is a resource for stream.

isTempFile - is true if the resource file is a temporary file and should be deleted when closing resource.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class ASInputStream

Throws:

IOException

read

public int read(byte[] buffer,
                int sizeToRead)
         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

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

incrementResourceUsers

public void incrementResourceUsers()

Description copied from class: ASInputStream

Method increments number of resource users. closeResource

Specified by:

incrementResourceUsers in class ASInputStream

decrementResourceUsers

public void decrementResourceUsers()

Description copied from class: ASInputStream

Method decrements number of resource users. closeResource

Specified by:

decrementResourceUsers in class ASInputStream

reset

public void reset()

Specified by:

reset in class ASInputStream

getFilePath

public String getFilePath()