Package org.apache.pdfbox.io
Class RandomAccessFileOutputStream
java.lang.Object
java.io.OutputStream
org.apache.pdfbox.io.RandomAccessFileOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
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.6 $
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor to create an output stream that will write to the end of a random access file. -
Method Summary
Modifier and TypeMethodDescriptionThis will get the length that the PDF document specified this stream should be.long
The number of bytes written or expected in the stream.long
Get the amount of data that was actually written to the stream, in theory this should be the same as the length specified but in some cases it doesn't match.long
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) Methods inherited from class java.io.OutputStream
close, flush, nullOutputStream, write
-
Constructor Details
-
RandomAccessFileOutputStream
Constructor to create an output stream that will write to the end of a random access file.- Parameters:
raf
- The file to write to.- Throws:
IOException
- If there is a problem accessing the raf.
-
-
Method Details
-
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.
-
getLengthWritten
public long getLengthWritten()Get the amount of data that was actually written to the stream, in theory this should be the same as the length specified but in some cases it doesn't match.- Returns:
- The number of bytes actually written to this stream.
-
getLength
public long getLength()The number of bytes written or expected in the stream.- Returns:
- The number of bytes written or expected in the stream.
-
write
- Overrides:
write
in classOutputStream
- Throws:
IOException
-
write
- Specified by:
write
in classOutputStream
- Throws:
IOException
-
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.
-
setExpectedLength
This will set the expected length of this stream.- Parameters:
value
- The expected value.
-