org.pdfbox.io

Class RandomAccessFileOutputStream


public class RandomAccessFileOutputStream
extends OutputStream

This will write to a RandomAccessFile in the filesystem and keep track of the position it is writing to and the length of the stream.
Version:
$Revision: 1.5 $
Author:
Ben Litchfield

Constructor Summary

RandomAccessFileOutputStream(RandomAccess raf)
Constructor to create an output stream that will write to the end of a random access file.

Method Summary

COSBase
getExpectedLength()
This will get the length that the PDF document specified this stream should be.
long
getLength()
The number of bytes written to the stream.
long
getPosition()
This will get the position in the RAF that the stream was written to.
void
setExpectedLength(COSBase value)
This will set the expected length of this stream.
void
write(byte[] b, int offset, int length)
void
write(int b)

Constructor Details

RandomAccessFileOutputStream

public RandomAccessFileOutputStream(RandomAccess raf)
            throws IOException
Constructor to create an output stream that will write to the end of a random access file.
Parameters:
raf - The file to write to.

Method Details

getExpectedLength

public COSBase getExpectedLength()
This will get the length that the PDF document specified this stream should be. This may not match the number of bytes read.
Returns:
The expected length.

getLength

public long getLength()
The number of bytes written to the stream.
Returns:
The number of bytes read to the stream.

getPosition

public long getPosition()
This will get the position in the RAF that the stream was written to.
Returns:
The position in the raf where the file can be obtained.

setExpectedLength

public void setExpectedLength(COSBase value)
This will set the expected length of this stream.
Parameters:
value - The expected value.

write

public void write(byte[] b,
                  int offset,
                  int length)
            throws IOException

write

public void write(int b)
            throws IOException