Package com.itextpdf.io.source

Class RunLengthOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.itextpdf.io.source.RunLengthOutputStream

All Implemented Interfaces:

IFinishable, Closeable, Flushable, AutoCloseable

       public class RunLengthOutputStream extends FilterOutputStream implements IFinishable
      

An output stream that encodes data according to the RunLengthDecode filter from the PDF specification.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
RunLengthOutputStream(OutputStream out)	Creates a new RunLengthDecode encoding stream.

Method Summary

Modifier and Type	Method	Description
void	close()
void	finish()	Is called to finalize the stream, implementing classes should ensure that the underlying output stream remains open after this method is called.
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

flush, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

RunLengthOutputStream

             public RunLengthOutputStream
             (OutputStream out)
            

Creates a new RunLengthDecode encoding stream.

Parameters:

out - the output stream to write encoded data to

Method Details

write

             public void write
             (int b) throws IOException
            

Overrides:

write in class FilterOutputStream

Throws:

IOException

close

             public void close() throws IOException
            

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

finish

             public void finish() throws IOException
            

Is called to finalize the stream, implementing classes should ensure that the underlying output stream remains open after this method is called.

This method completes any pending write operations, flushes internal buffers, writes any final data required by the stream format, and releases resources associated with the stream processing. However, unlike OutputStream.close(), it does not close the underlying output stream.

After calling this method, no further data should be written to this stream, but the underlying stream remains open and can be used for other operations.

This method should be idempotent - calling it multiple times should have the same effect as calling it once.

Specified by:

finish in interface IFinishable

Throws:

IOException - if an I/O error occurs during finalization