Package org.verapdf.as.io

Class ASMemoryInStream

java.lang.Object

java.io.InputStream

org.verapdf.as.io.ASInputStream

org.verapdf.io.SeekableInputStream

org.verapdf.as.io.ASMemoryInStream

All Implemented Interfaces:

Closeable, AutoCloseable, BaseParserInputStream

public class ASMemoryInStream
extends SeekableInputStream

This class binds the SeekableInputStream interface to a memory buffer.

Author:

Sergey Shemyakov

Field Summary

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

isClosed, isSourceClosed, resourceUsers

Constructor Summary

Constructors

Constructor	Description
ASMemoryInStream(byte[] buffer)	Constructor from byte array.
ASMemoryInStream(byte[] buffer, int bufferSize)	Constructor from byte array and actual data length.
ASMemoryInStream(byte[] buffer, int bufferSize, boolean copyBuffer)	Constructor from byte array and actual data length.
ASMemoryInStream(InputStream stream)	Constructor from other stream.
ASMemoryInStream(ASMemoryInStream stream, int offset, int length)	Constructor that creates substream from other ASMemoryInStream.

Method Summary

Modifier and Type	Method	Description
int	available()
void	closeResource()	Closes stream.
long	getCurrentOffset()
long	getOffset()	Gets offset of current byte.
SeekableInputStream	getSeekableStream(long startOffset, long length)
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.
boolean	isCopiedBuffer()
void	mark(int readlimit)
boolean	markSupported()
int	peek()	Gets next byte without reading it.
int	read()	Reads single byte.
int	read(byte[] buffer, int size)	Reads up to size bytes of data into given array.
void	reset()	Resets stream.
void	seek(long offset)	Goes to a particular byte in stream.
int	skip(int size)	Skips up to size bytes of data.

Methods inherited from class org.verapdf.io.SeekableInputStream

decrementResourceUsers, getSeekableStream, 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

nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.verapdf.parser.BaseParserInputStream

close, read

Constructor Details

ASMemoryInStream

public ASMemoryInStream(byte[] buffer)

Constructor from byte array. Buffer is copied while initializing ASMemoryInStream.

Parameters:

buffer - byte array containing data.

ASMemoryInStream

public ASMemoryInStream(InputStream stream)
                 throws IOException

Constructor from other stream. It reads stream into byte buffer.

Parameters:

stream - is stream to read into byte array.

Throws:

IOException

ASMemoryInStream

public ASMemoryInStream(ASMemoryInStream stream,
 int offset,
 int length)

Constructor that creates substream from other ASMemoryInStream. Note that no buffer copy is performed.

Parameters:

stream - is stream, from which substream will be taken.

offset - is beginning of data to copy.

length - is length of data to copy.

ASMemoryInStream

public ASMemoryInStream(byte[] buffer,
 int bufferSize)

Constructor from byte array and actual data length. Buffer is copied while initializing ASMemoryInStream.

Parameters:

buffer - byte array containing data.

bufferSize - actual length of data in buffer.

ASMemoryInStream

public ASMemoryInStream(byte[] buffer,
 int bufferSize,
 boolean copyBuffer)

Constructor from byte array and actual data length. Whether buffer is copied deeply or just reference is copied can be manually set.

Parameters:

buffer - byte array containing data.

bufferSize - actual length of data in buffer.

copyBuffer - is true if buffer should be copied deeply. Note that if it is set into false then internal buffer can be changed from outside of this class.

Method Details

getCurrentOffset

public long getCurrentOffset()

Specified by:

getCurrentOffset in class SeekableInputStream

read

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

Reads up to size bytes of data into given array.

Specified by:

read in class ASInputStream

Parameters:

buffer - is array into which data is read.

size - is maximal amount of data that can be read.

Returns:

actual amount of bytes reas.

Throws:

IOException

read

public int read()
         throws IOException

Reads single byte.

Specified by:

read in interface BaseParserInputStream

Specified by:

read in class ASInputStream

Returns:

byte read or -1 if end is reached.

Throws:

IOException

peek

public int peek()
         throws IOException

Gets next byte without reading it.

Specified by:

peek in interface BaseParserInputStream

Specified by:

peek in class SeekableInputStream

Returns:

next byte.

Throws:

IOException

skip

public int skip(int size)
         throws IOException

Skips up to size bytes of data.

Specified by:

skip in interface BaseParserInputStream

Specified by:

skip in class ASInputStream

Parameters:

size - is amount of bytes to skip.

Returns:

actual amount of bytes skipped.

Throws:

IOException

closeResource

public void closeResource()
                   throws IOException

Closes stream.

Specified by:

closeResource in class ASInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Resets stream.

Specified by:

reset in class ASInputStream

Throws:

IOException

getStreamLength

public long getStreamLength()
                     throws IOException

Gets total length of stream.

Specified by:

getStreamLength in class SeekableInputStream

Returns:

length of stream in bytes.

Throws:

IOException

getOffset

public long getOffset()
               throws IOException

Gets offset of current byte.

Specified by:

getOffset in class SeekableInputStream

Returns:

offset of byte to be read next.

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

available

public int available()

Overrides:

available in class InputStream

Returns:

the amount of bytes left in stream.

isCopiedBuffer

public boolean isCopiedBuffer()

Returns:

true if internal buffer was copied deeply.

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

getSeekableStream

public SeekableInputStream getSeekableStream(long startOffset,
 long length)
                                      throws IOException

Specified by:

getSeekableStream in class SeekableInputStream

Throws:

IOException