Module com.aoapps.hodgepodge

Package com.aoapps.hodgepodge.io

Class PaddingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.aoapps.hodgepodge.io.PaddingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class PaddingOutputStream
extends FilterOutputStream

Pads the last block with the necessary number of bytes before closing the stream. If padding is necessary without closing, use finish.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
PaddingOutputStream(OutputStream out, int blockSize)	Uses a default instance of SecureRandom, which is not a strong instance to avoid blocking, as the source of random bytes for padding.
PaddingOutputStream(OutputStream out, int blockSize, byte padding)	Deprecated. Please use random padding
PaddingOutputStream(OutputStream out, int blockSize, SecureRandom secureRandom)	Uses the given source of random bytes for padding.
PaddingOutputStream(OutputStream out, int blockSize, Random random)	Deprecated. Please use SecureRandom.

Method Summary

Modifier and Type	Method	Description
void	close()	Pads, flushes, and closes the underlying stream.
void	finish()	Pads and flushes without closing the underlying stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

flush

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 Detail

PaddingOutputStream

@Deprecated
public PaddingOutputStream(OutputStream out,
                           int blockSize,
                           Random random)

Deprecated.

Please use SecureRandom. This method will stay, but will remain deprecated since it should only be used after careful consideration.

Uses the given source of random bytes for padding.

Parameters:

blockSize - When <= 0, no padding will be performed. This is consistent with zero returned from Cipher.getBlockSize() when not a block cipher.

PaddingOutputStream

public PaddingOutputStream(OutputStream out,
                           int blockSize,
                           SecureRandom secureRandom)

Uses the given source of random bytes for padding.

Parameters:

blockSize - When <= 0, no padding will be performed. This is consistent with zero returned from Cipher.getBlockSize() when not a block cipher.

PaddingOutputStream

public PaddingOutputStream(OutputStream out,
                           int blockSize)

Uses a default instance of SecureRandom, which is not a strong instance to avoid blocking, as the source of random bytes for padding.

Parameters:

blockSize - When <= 0, no padding will be performed. This is consistent with zero returned from Cipher.getBlockSize() when not a block cipher.

PaddingOutputStream

@Deprecated
public PaddingOutputStream(OutputStream out,
                           int blockSize,
                           byte padding)

Deprecated.

Please use random padding

Method Detail

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

finish

public void finish()
            throws IOException

Pads and flushes without closing the underlying stream.

Throws:

IOException

close

public void close()
           throws IOException

Pads, flushes, and closes the underlying stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException