Package google.registry.util

Class ImprovedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

google.registry.util.ImprovedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class ImprovedInputStream
extends FilterInputStream

InputStream wrapper that offers some additional magic.

• Byte counting
• Log byte count on close
• Check expected byte count when closed (Optional)
• Close original InputStream when closed (Optional)
• Overridable onClose() method
• Throws NullPointerException if read after close()

See Also:

• ImprovedOutputStream
• CountingInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ImprovedInputStream(String name, InputStream out)
ImprovedInputStream(String name, InputStream in, boolean shouldClose)

Method Summary

Modifier and Type	Method	Description
void	close()	Logs byte count, checks byte count (optional), closes (optional), and self-sabotages.
void	mark(int readlimit)
protected void	onClose()	Overridable method that's called by close().
int	read()
final int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

available, markSupported

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ImprovedInputStream

public ImprovedInputStream(String name,
 @WillCloseWhenClosed
 InputStream out)

ImprovedInputStream

public ImprovedInputStream(String name,
 InputStream in,
 boolean shouldClose)

Method Details

read

@OverridingMethodsMustInvokeSuper
public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public final int read(byte[] b)
               throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

close

@NonFinalForTesting
public void close()
           throws IOException

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 FilterInputStream

Throws:

IOException

See Also:

• InputStream.close()

onClose

protected void onClose()
                throws IOException

Overridable method that's called by close().

This method does nothing by default.

Throws:

IOException