com.pdf_tools.fourheights.pdftoolbox.sys

Class MemoryStream

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.sys.MemoryStream

All Implemented Interfaces:

Stream, java.lang.AutoCloseable

public class MemoryStream
extends java.lang.Object
implements Stream

Constructor Summary

Constructors

Constructor and Description
MemoryStream() Create a new memory stream with initial capacity 0 and block size 8192 Bytes
MemoryStream(byte[] buffer, int offset, int length) Create a new memory stream with block size 8192 by copying from a buffer
MemoryStream(byte[] buffer, int offset, int length, int blockSize) Create a new memory stream by copying from a buffer
MemoryStream(long initialCapacity) Create a new memory stream with block size 8192 Bytes
MemoryStream(long initialCapacity, int blockSize) Create a new memory stream
MemoryStream(Stream stream) Create a new memory with block size 8192 stream by copying a stream
MemoryStream(Stream stream, int blockSize) Create a new memory stream by copying a stream

Method Summary

Modifier and Type	Method and Description
void	close()
long	getLength() Get the length of the stream in bytes
int	read(byte[] buffer, int offset, int length) Read from the stream
boolean	seek(long position) Set byte position
long	tell() Get current byte position
void	write(byte[] buffer, int offset, int length) Write to the stream

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryStream

public MemoryStream(long initialCapacity,
                    int blockSize)

Create a new memory stream

Parameters:

initialCapacity - The initial capacity of the stream. The length of the stream is still 0

blockSize - The size of the memory blocks used to store the data

MemoryStream

public MemoryStream(long initialCapacity)

Create a new memory stream with block size 8192 Bytes

Parameters:

initialCapacity - The initial capacity of the stream. The length of the stream is still 0

MemoryStream

public MemoryStream()

Create a new memory stream with initial capacity 0 and block size 8192 Bytes

MemoryStream

public MemoryStream(byte[] buffer,
                    int offset,
                    int length,
                    int blockSize)

Create a new memory stream by copying from a buffer

Parameters:

buffer - The buffer from which the initial data is copied

offset - The offset where the first byte from the buffer is copied

length - The number of bytes that are copied from the buffer

blockSize - The size of the memory blocks used to store the data

MemoryStream

public MemoryStream(byte[] buffer,
                    int offset,
                    int length)

Create a new memory stream with block size 8192 by copying from a buffer

Parameters:

buffer - The buffer from which the initial data is copied

offset - The offset where the first byte from the buffer is copied

length - The number of bytes that are copied from the buffer

MemoryStream

public MemoryStream(Stream stream,
                    int blockSize)
             throws java.io.IOException

Create a new memory stream by copying a stream

Parameters:

stream - The stream from which the initial data is copied

blockSize - The size of the memory blocks used to store the data

Throws:

java.io.IOException

MemoryStream

public MemoryStream(Stream stream)
             throws java.io.IOException

Create a new memory with block size 8192 stream by copying a stream

Parameters:

stream - The stream from which the initial data is copied

Throws:

java.io.IOException

Method Detail

getLength

public long getLength()

Get the length of the stream in bytes

Specified by:

getLength in interface Stream

Returns:

the length of the stream in bytes

seek

public boolean seek(long position)

Set byte position

Specified by:

seek in interface Stream

Parameters:

position - The new position of the stream (-1 for EOS)

Returns:

true if successful

tell

public long tell()

Get current byte position

Specified by:

tell in interface Stream

Returns:

byte position, -1 if position unknown

read

public int read(byte[] buffer,
                int offset,
                int length)

Read from the stream

Specified by:

read in interface Stream

Parameters:

buffer - The buffer where the data is written

offset - The starting element in the buffer

length - The maximum number of bytes to be read

Returns:

The actual number of bytes read (-1 if EOS)

write

public void write(byte[] buffer,
                  int offset,
                  int length)

Write to the stream

Specified by:

write in interface Stream

Parameters:

buffer - The buffer where the data lies

offset - The starting element in the buffer

length - The maximum number of bytes to be written

close

public void close()
           throws java.io.IOException

Specified by:

close in interface Stream

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException