Package io.grpc.internal

Class ReadableBuffers

java.lang.Object

io.grpc.internal.ReadableBuffers

public final class ReadableBuffers
extends Object

Utility methods for creating ReadableBuffer instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ReadableBuffers.BufferInputStream	An InputStream that is backed by a ReadableBuffer.
private static class	ReadableBuffers.ByteArrayWrapper	A ReadableBuffer that is backed by a byte array.
private static class	ReadableBuffers.ByteReadableBufferWrapper	A ReadableBuffer that is backed by a ByteBuffer.

Field Summary

Fields

Modifier and Type	Field	Description
private static final ReadableBuffer	EMPTY_BUFFER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ReadableBuffers()

Method Summary

Modifier and Type	Method	Description
static ReadableBuffer	empty()	Returns an empty ReadableBuffer instance.
static ReadableBuffer	ignoreClose(ReadableBuffer buffer)	Decorates the given ReadableBuffer to ignore calls to ReadableBuffer.close().
static InputStream	openStream(ReadableBuffer buffer, boolean owner)	Creates a new InputStream backed by the given buffer.
static byte[]	readArray(ReadableBuffer buffer)	Reads an entire ReadableBuffer to a new array.
static String	readAsString(ReadableBuffer buffer, Charset charset)	Reads the entire ReadableBuffer to a new String with the given charset.
static String	readAsStringUtf8(ReadableBuffer buffer)	Reads the entire ReadableBuffer to a new String using UTF-8 decoding.
static ReadableBuffer	wrap(byte[] bytes)	Shortcut for wrap(bytes, 0, bytes.length.
static ReadableBuffer	wrap(byte[] bytes, int offset, int length)	Creates a new ReadableBuffer that is backed by the given byte array.
static ReadableBuffer	wrap(ByteBuffer bytes)	Creates a new ReadableBuffer that is backed by the given ByteBuffer.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_BUFFER

private static final ReadableBuffer EMPTY_BUFFER

Constructor Details

ReadableBuffers

private ReadableBuffers()

Method Details

empty

public static ReadableBuffer empty()

Returns an empty ReadableBuffer instance.

wrap

public static ReadableBuffer wrap(byte[] bytes)

Shortcut for wrap(bytes, 0, bytes.length.

wrap

public static ReadableBuffer wrap(byte[] bytes,
 int offset,
 int length)

Creates a new ReadableBuffer that is backed by the given byte array.

Parameters:

bytes - the byte array being wrapped.

offset - the starting offset for the buffer within the byte array.

length - the length of the buffer from the offset index.

wrap

public static ReadableBuffer wrap(ByteBuffer bytes)

Creates a new ReadableBuffer that is backed by the given ByteBuffer. Calls to read from the buffer will increment the position of the ByteBuffer.

readArray

public static byte[] readArray(ReadableBuffer buffer)

Reads an entire ReadableBuffer to a new array. After calling this method, the buffer will contain no readable bytes.

readAsString

public static String readAsString(ReadableBuffer buffer,
 Charset charset)

Reads the entire ReadableBuffer to a new String with the given charset.

readAsStringUtf8

public static String readAsStringUtf8(ReadableBuffer buffer)

Reads the entire ReadableBuffer to a new String using UTF-8 decoding.

openStream

public static InputStream openStream(ReadableBuffer buffer,
 boolean owner)

Creates a new InputStream backed by the given buffer. Any read taken on the stream will automatically increment the read position of this buffer. Closing the stream, however, does not affect the original buffer.

Parameters:

buffer - the buffer backing the new InputStream.

owner - if true, the returned stream will close the buffer when closed.

ignoreClose

public static ReadableBuffer ignoreClose(ReadableBuffer buffer)

Decorates the given ReadableBuffer to ignore calls to ReadableBuffer.close().

Parameters:

buffer - the buffer to be decorated.

Returns:

a wrapper around buffer that ignores calls to ReadableBuffer.close().