Package io.deephaven.extensions.barrage.util

Class DefensiveDrainable

java.lang.Object

java.io.InputStream

io.deephaven.extensions.barrage.util.DefensiveDrainable

All Implemented Interfaces:

io.grpc.Drainable, io.grpc.KnownLength, Closeable, AutoCloseable

Direct Known Subclasses:

ChunkWriter.DrainableColumn, ConsecutiveDrainableStreams, DrainableByteArrayInputStream

public abstract class DefensiveDrainable
extends InputStream
implements io.grpc.Drainable, io.grpc.KnownLength

A defensive Drainable implementation that supports the non-read methods of InputStream. Callers should use Drainable.drainTo(OutputStream) when applicable. If handing off to external code that needs a real InputStream, use capture().

Constructor Summary

Constructors

Constructor	Description
DefensiveDrainable()

Method Summary

Modifier and Type	Method	Description
int	available()	A defensive drainable needs to override available.
final InputStream	capture()	Captures this drainable as a real InputStream.
final int	read()
final int	read(@org.jetbrains.annotations.NotNull byte[] b)
final int	read(@org.jetbrains.annotations.NotNull byte[] b, int off, int len)
final long	skip(long n)

Methods inherited from class java.io.InputStream

close, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.Drainable

drainTo

Constructor Details

DefensiveDrainable

public DefensiveDrainable()

Method Details

read

public final int read(@NotNull
 @org.jetbrains.annotations.NotNull byte[] b)
               throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public final int read(@NotNull
 @org.jetbrains.annotations.NotNull byte[] b,
 int off,
 int len)
               throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public final long skip(long n)
                throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

read

public final int read()
               throws IOException

Specified by:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

A defensive drainable needs to override available. As opposed to the generic InputStream, this method must return the exact amount available.

Specified by:

available in interface io.grpc.KnownLength

Overrides:

available in class InputStream

Returns:

the exact amount available

Throws:

IOException - if an I/O exception occurs

capture

public final InputStream capture()

Captures this drainable as a real InputStream.

Returns:

a real input stream