Package google.registry.util

Class ImprovedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

google.registry.util.ImprovedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

RydePgpSigningOutputStream

@NotThreadSafe
public class ImprovedOutputStream
extends FilterOutputStream

OutputStream wrapper that offers some additional magic.

• Byte counting
• Always FilterOutputStream.flush() on close()
• Check expected byte count when closed (Optional)
• Close original OutputStream when closed (Optional)
• Overridable onClose() method
• Throws NullPointerException if written after close()

See Also:

• ImprovedInputStream
• CountingOutputStream

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
ImprovedOutputStream(String name, OutputStream out)
ImprovedOutputStream(String name, OutputStream out, boolean shouldClose)

Method Summary

Modifier and Type	Method	Description
void	close()	Flushes, logs byte count, checks byte count (optional), closes (optional), and self-sabotages.
long	getBytesWritten()	Returns the number of bytes that have been written to this stream thus far.
protected void	onClose()	Overridable method that's called by close().
final 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 Details

ImprovedOutputStream

public ImprovedOutputStream(String name,
 @WillCloseWhenClosed
 OutputStream out)

ImprovedOutputStream

public ImprovedOutputStream(String name,
 OutputStream out,
 boolean shouldClose)

Method Details

getBytesWritten

public long getBytesWritten()

Returns the number of bytes that have been written to this stream thus far.

write

@OverridingMethodsMustInvokeSuper
public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.write(int)

write

public final void write(byte[] b)
                 throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• write(byte[], int, int)

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

• FilterOutputStream.write(byte[], int, int)

close

@NonFinalForTesting
public void close()
           throws IOException

Flushes, logs byte count, checks byte count (optional), closes (optional), and self-sabotages.

This method may not be overridden, use onClose() instead.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

See Also:

• OutputStream.close()

onClose

protected void onClose()
                throws IOException

Overridable method that's called by close().

This method does nothing by default.

Throws:

IOException