public final class RealBufferedSource extends Object implements BufferedSource
| Constructor and Description |
|---|
RealBufferedSource(Source source) |
| Modifier and Type | Method and Description |
|---|---|
Buffer |
buffer() |
void |
close()
Closes this source and releases the resources held by this source.
|
boolean |
exhausted() |
Buffer |
getBuffer() |
long |
indexOf(byte b)
Equivalent to
indexOf(b, 0). |
long |
indexOf(byte b,
long fromIndex)
Returns the index of the first
b in the buffer at or after fromIndex. |
long |
indexOf(byte b,
long fromIndex,
long toIndex)
Returns the index of
b if it is found in the range of fromIndex inclusive
to toIndex exclusive. |
long |
indexOf(ByteString bytes)
Equivalent to
indexOf(bytes, 0). |
long |
indexOf(ByteString bytes,
long fromIndex)
Returns the index of the first match for
bytes in the buffer at or after fromIndex. |
long |
indexOfElement(ByteString targetBytes) |
long |
indexOfElement(ByteString targetBytes,
long fromIndex) |
InputStream |
inputStream()
an input stream that reads from this source.
|
boolean |
isOpen() |
BufferedSource |
peek()
a new
BufferedSource that can read data from this BufferedSource
without consuming it. |
boolean |
rangeEquals(long offset,
ByteString bytes)
true if the bytes at
offset in this source equal bytes. |
boolean |
rangeEquals(long offset,
ByteString bytes,
int bytesOffset,
int byteCount)
if
byteCount bytes at offset in this source equal bytes
* at bytesOffset. |
long |
read(Buffer sink,
long byteCount)
Removes at least 1, and up to
byteCount bytes from this and appends
them to sink. |
int |
read(byte[] sink)
Removes up to
sink.length bytes from this and copies them into sink. |
int |
read(byte[] sink,
int offset,
int byteCount)
Removes up to
byteCount bytes from this and copies them into sink at offset. |
int |
read(ByteBuffer sink) |
long |
readAll(Sink sink)
Removes all bytes from this and appends them to
sink. |
byte |
readByte() |
byte[] |
readByteArray()
Removes all bytes from this and returns them as a byte array.
|
byte[] |
readByteArray(long byteCount)
Removes
byteCount bytes from this and returns them as a byte array. |
ByteString |
readByteString()
Removes all bytes bytes from this and returns them as a byte string.
|
ByteString |
readByteString(long byteCount)
Removes
byteCount bytes from this and returns them as a byte string. |
long |
readDecimalLong()
Reads a long from this source in signed decimal form (i.e., as a string in base 10 with
optional leading '-').
|
void |
readFully(Buffer sink,
long byteCount)
Removes exactly
byteCount bytes from this and appends them to sink. |
void |
readFully(byte[] sink)
Removes exactly
sink.length bytes from this and copies them into sink. |
long |
readHexadecimalUnsignedLong()
Reads a long form this source in hexadecimal form (i.e., as a string in base 16).
|
int |
readInt() |
int |
readIntLe() |
long |
readLong() |
long |
readLongLe()
Removes eight bytes from this source and returns a little-endian long.
|
short |
readShort() |
short |
readShortLe()
Removes two bytes from this source and returns a little-endian short.
|
String |
readString(Charset charset) |
String |
readString(long byteCount,
Charset charset)
Removes
byteCount bytes from this, decodes them as charset, |
String |
readUtf8()
Removes all bytes from this, decodes them as UTF-8, and returns the string.
|
String |
readUtf8(long byteCount)
Removes
byteCount bytes from this, decodes them as UTF-8, and returns the string. |
int |
readUtf8CodePoint() |
String |
readUtf8Line()
Removes and returns characters up to but not including the next line break.
|
String |
readUtf8LineStrict()
Removes and returns characters up to but not including the next line break.
|
String |
readUtf8LineStrict(long limit)
Like
BufferedSource.readUtf8LineStrict(), except this allows the caller to specify the longest
allowed match. |
boolean |
request(long byteCount) |
void |
require(long byteCount)
when the buffer contains at least
byteCount bytes. |
int |
select(Options options)
Finds the first string in
options that is a prefix of this buffer, consumes it from
this buffer, and returns its index. |
void |
skip(long byteCount)
Reads and discards
byteCount bytes from this source. |
Timeout |
timeout()
Returns the timeout for this source.
|
String |
toString() |
public RealBufferedSource(Source source)
public Buffer buffer()
buffer in interface BufferedSourcepublic Buffer getBuffer()
getBuffer in interface BufferedSourcepublic long read(Buffer sink, long byteCount) throws IOException
SourcebyteCount bytes from this and appends
them to sink. Returns the number of bytes read, or -1 if this
source is exhausted.read in interface Sourcesink - BufferbyteCount - longIOException - IOException IOException.public boolean exhausted()
throws IOException
exhausted in interface BufferedSourceIOException - IOException IOException.public void require(long byteCount)
throws IOException
BufferedSourcebyteCount bytes.require in interface BufferedSourcebyteCount - longIOException - IOException IOException.public boolean request(long byteCount)
throws IOException
request in interface BufferedSourcebyteCount - longbyteCount bytes, expanding it as
necessary. Returns false if the source is exhausted before the requested bytes can be read.IOException - IOException IOException.public byte readByte()
throws IOException
readByte in interface BufferedSourceIOException - IOException IOException.public ByteString readByteString() throws IOException
BufferedSourcereadByteString in interface BufferedSourceIOException - IOException IOException.public ByteString readByteString(long byteCount) throws IOException
BufferedSourcebyteCount bytes from this and returns them as a byte string.readByteString in interface BufferedSourcebyteCount - longIOException - IOException IOException.public int select(Options options) throws IOException
BufferedSourceoptions that is a prefix of this buffer, consumes it from
this buffer, and returns its index. If no byte string in options is a prefix of this
buffer this returns -1 and no bytes are consumed.
This can be used as an alternative to BufferedSource.readByteString() or even BufferedSource.readUtf8() if
the set of expected values is known in advance.
Options FIELDS = Options.of(
ByteString.encodeUtf8("depth="),
ByteString.encodeUtf8("height="),
ByteString.encodeUtf8("width="));
Buffer buffer = new Buffer()
.writeUtf8("width=640\n")
.writeUtf8("height=480\n");
assertEquals(2, buffer.select(FIELDS));
assertEquals(640, buffer.readDecimalLong());
assertEquals('\n', buffer.readByte());
assertEquals(1, buffer.select(FIELDS));
assertEquals(480, buffer.readDecimalLong());
assertEquals('\n', buffer.readByte());
select in interface BufferedSourceoptions - OptionsIOException - IOException IOException.public byte[] readByteArray()
throws IOException
BufferedSourcereadByteArray in interface BufferedSourceIOException - IOException IOException.public byte[] readByteArray(long byteCount)
throws IOException
BufferedSourcebyteCount bytes from this and returns them as a byte array.readByteArray in interface BufferedSourcebyteCount - longIOException - IOException IOException.public int read(byte[] sink)
throws IOException
BufferedSourcesink.length bytes from this and copies them into sink. Returns
the number of bytes read, or -1 if this source is exhausted.read in interface BufferedSourcesink - byte[]IOException - IOException IOException.public void readFully(byte[] sink)
throws IOException
BufferedSourcesink.length bytes from this and copies them into sink. Throws
an IOException if the requested number of bytes cannot be read.readFully in interface BufferedSourcesink - byte[]IOException - IOException IOException.public int read(byte[] sink,
int offset,
int byteCount)
throws IOException
BufferedSourcebyteCount bytes from this and copies them into sink at offset. Returns the number of bytes read, or -1 if this source is exhausted.read in interface BufferedSourcesink - byte[]offset - intbyteCount - intIOException - IOException IOException.public int read(ByteBuffer sink) throws IOException
read in interface ReadableByteChannelIOExceptionpublic void readFully(Buffer sink, long byteCount) throws IOException
BufferedSourcebyteCount bytes from this and appends them to sink. Throws an
IOException if the requested number of bytes cannot be read.readFully in interface BufferedSourcesink - BufferbyteCount - longIOException - IOException IOException.public long readAll(Sink sink) throws IOException
BufferedSourcesink. Returns the total number of bytes
written to sink which will be 0 if this is exhausted.readAll in interface BufferedSourcesink - SinkIOException - IOException IOException.public String readUtf8() throws IOException
BufferedSource
Buffer buffer = new Buffer()
.writeUtf8("Uh uh uh!")
.writeByte(' ')
.writeUtf8("You didn't say the magic word!");
assertEquals("Uh uh uh! You didn't say the magic word!", buffer.readUtf8());
assertEquals(0, buffer.size());
assertEquals("", buffer.readUtf8());
assertEquals(0, buffer.size());
readUtf8 in interface BufferedSourceIOException - IOException IOException.public String readUtf8(long byteCount) throws IOException
BufferedSourcebyteCount bytes from this, decodes them as UTF-8, and returns the string.
Buffer buffer = new Buffer()
.writeUtf8("Uh uh uh!")
.writeByte(' ')
.writeUtf8("You didn't say the magic word!");
assertEquals(40, buffer.size());
assertEquals("Uh uh uh! You ", buffer.readUtf8(14));
assertEquals(26, buffer.size());
assertEquals("didn't say the", buffer.readUtf8(14));
assertEquals(12, buffer.size());
assertEquals(" magic word!", buffer.readUtf8(12));
assertEquals(0, buffer.size());
readUtf8 in interface BufferedSourcebyteCount - longIOException - IOException IOException.public String readString(Charset charset) throws IOException
readString in interface BufferedSourcecharset - Charset Removes all bytes from this, decodes them as charset,IOException - IOException IOException.public String readString(long byteCount, Charset charset) throws IOException
BufferedSourcebyteCount bytes from this, decodes them as charset,readString in interface BufferedSourcebyteCount - byteCountcharset - CharsetIOException - IOException IOException.public String readUtf8Line() throws IOException
BufferedSource"\n" or "\r\n"; these characters are not included in the result.
Buffer buffer = new Buffer()
.writeUtf8("I'm a hacker!\n")
.writeUtf8("That's what I said: you're a nerd.\n")
.writeUtf8("I prefer to be called a hacker!\n");
assertEquals(81, buffer.size());
assertEquals("I'm a hacker!", buffer.readUtf8Line());
assertEquals(67, buffer.size());
assertEquals("That's what I said: you're a nerd.", buffer.readUtf8Line());
assertEquals(32, buffer.size());
assertEquals("I prefer to be called a hacker!", buffer.readUtf8Line());
assertEquals(0, buffer.size());
assertEquals(null, buffer.readUtf8Line());
assertEquals(0, buffer.size());
On the end of the stream this method returns null, just like BufferedReader. If the source doesn't end with a line break then an implicit line
break is assumed. Null is returned once the source is exhausted. Use this for human-generated
data, where a trailing line break is optional.
readUtf8Line in interface BufferedSourceIOException - IOException IOException.public String readUtf8LineStrict() throws IOException
BufferedSource"\n" or "\r\n"; these characters are not included in the result.
On the end of the stream this method throws. Every call must consume either
'\r\n' or '\n'. If these characters are absent in the stream, an IOException
is thrown. Use this for machine-generated data where a missing line break implies truncated
input.
readUtf8LineStrict in interface BufferedSourceIOException - IOException IOException.public String readUtf8LineStrict(long limit) throws IOException
BufferedSourceBufferedSource.readUtf8LineStrict(), except this allows the caller to specify the longest
allowed match. Use this to protect against streams that may not include
"\n" or "\r\n".
The returned string will have at most limit UTF-8 bytes, and the maximum number
of bytes scanned is limit + 2. If limit == 0 this will always throw
an IOException because no bytes will be scanned.
This method is safe. No bytes are discarded if the match fails, and the caller is free to try another match:
Buffer buffer = new Buffer();
buffer.writeUtf8("12345\r\n");
// This will throw! There must be \r\n or \n at the limit or before it.
buffer.readUtf8LineStrict(4);
// No bytes have been consumed so the caller can retry.
assertEquals("12345", buffer.readUtf8LineStrict(5));
readUtf8LineStrict in interface BufferedSourcelimit - longIOException - IOException IOException.public int readUtf8CodePoint()
throws IOException
readUtf8CodePoint in interface BufferedSourceIf this source is exhausted before a complete code point can be read, this throws an IOException and consumes no input.
If this source doesn't start with a properly-encoded UTF-8 code point, this method will
remove 1 or more non-UTF-8 bytes and return the replacement character (U+FFFD). This
covers encoding problems (the input is not properly-encoded UTF-8), characters out of range
(beyond the 0x10ffff limit of Unicode), code points for UTF-16 surrogates (U+d800..U+dfff) and
overlong encodings (such as 0xc080 for the NUL character in modified UTF-8).
IOException - IOException IOException.public short readShort()
throws IOException
readShort in interface BufferedSource
Buffer buffer = new Buffer()
.writeByte(0x7f)
.writeByte(0xff)
.writeByte(0x00)
.writeByte(0x0f);
assertEquals(4, buffer.size());
assertEquals(32767, buffer.readShort());
assertEquals(2, buffer.size());
assertEquals(15, buffer.readShort());
assertEquals(0, buffer.size());
IOException - IOException IOException.public short readShortLe()
throws IOException
BufferedSource
Buffer buffer = new Buffer()
.writeByte(0xff)
.writeByte(0x7f)
.writeByte(0x0f)
.writeByte(0x00);
assertEquals(4, buffer.size());
assertEquals(32767, buffer.readShortLe());
assertEquals(2, buffer.size());
assertEquals(15, buffer.readShortLe());
assertEquals(0, buffer.size());
readShortLe in interface BufferedSourceIOException - IOException IOException.public int readInt()
throws IOException
readInt in interface BufferedSourceIOException - IOException IOException.public int readIntLe()
throws IOException
readIntLe in interface BufferedSourceIOException - IOException IOException.public long readLong()
throws IOException
readLong in interface BufferedSourceIOException - IOException IOException.public long readLongLe()
throws IOException
BufferedSource
Buffer buffer = new Buffer()
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0xff)
.writeByte(0x7f)
.writeByte(0x0f)
.writeByte(0x00)
.writeByte(0x00)
.writeByte(0x00)
.writeByte(0x00)
.writeByte(0x00)
.writeByte(0x00)
.writeByte(0x00);
assertEquals(16, buffer.size());
assertEquals(9223372036854775807L, buffer.readLongLe());
assertEquals(8, buffer.size());
assertEquals(15, buffer.readLongLe());
assertEquals(0, buffer.size());
readLongLe in interface BufferedSourceIOException - IOException IOException.public long readDecimalLong()
throws IOException
BufferedSource
Buffer buffer = new Buffer()
.writeUtf8("8675309 -123 00001");
assertEquals(8675309L, buffer.readDecimalLong());
assertEquals(' ', buffer.readByte());
assertEquals(-123L, buffer.readDecimalLong());
assertEquals(' ', buffer.readByte());
assertEquals(1L, buffer.readDecimalLong());
readDecimalLong in interface BufferedSourceIOException - if the found digits do not fit into a long or a decimal
number was not present.public long readHexadecimalUnsignedLong()
throws IOException
BufferedSource
Buffer buffer = new Buffer()
.writeUtf8("ffff CAFEBABE 10");
assertEquals(65535L, buffer.readHexadecimalUnsignedLong());
assertEquals(' ', buffer.readByte());
assertEquals(0xcafebabeL, buffer.readHexadecimalUnsignedLong());
assertEquals(' ', buffer.readByte());
assertEquals(0x10L, buffer.readHexadecimalUnsignedLong());
readHexadecimalUnsignedLong in interface BufferedSourceIOException - if the found hexadecimal does not fit into a long or
hexadecimal was not found.public void skip(long byteCount)
throws IOException
BufferedSourcebyteCount bytes from this source. Throws an
IOException if the source is exhausted before the
requested bytes can be skipped.skip in interface BufferedSourcebyteCount - longIOException - IOException IOException.public long indexOf(byte b)
throws IOException
BufferedSourceindexOf(b, 0).indexOf in interface BufferedSourceb - byteIOException - IOException IOException.public long indexOf(byte b,
long fromIndex)
throws IOException
BufferedSourceb in the buffer at or after fromIndex. This
expands the buffer as necessary until b is found. This reads an unbounded number of
bytes into the buffer. Returns -1 if the stream is exhausted before the requested byte is
found.
Buffer buffer = new Buffer();
buffer.writeUtf8("Don't move! He can't see us if we don't move.");
byte m = 'm';
assertEquals(6, buffer.indexOf(m));
assertEquals(40, buffer.indexOf(m, 12));
indexOf in interface BufferedSourceb - bytefromIndex - longIOException - IOException IOException.public long indexOf(byte b,
long fromIndex,
long toIndex)
throws IOException
BufferedSourceb if it is found in the range of fromIndex inclusive
to toIndex exclusive. If b isn't found, or if fromIndex == toIndex,
then -1 is returned.
The scan terminates at either toIndex or the end of the buffer, whichever comes
first. The maximum number of bytes scanned is toIndex-fromIndex.
indexOf in interface BufferedSourceb - bytefromIndex - longtoIndex - longIOException - IOException IOException.public long indexOf(ByteString bytes) throws IOException
BufferedSourceindexOf(bytes, 0).indexOf in interface BufferedSourcebytes - ByteStringIOException - IOException IOException.public long indexOf(ByteString bytes, long fromIndex) throws IOException
BufferedSourcebytes in the buffer at or after fromIndex. This expands the buffer as necessary until bytes is found. This reads an
unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the
requested bytes are found.
ByteString MOVE = ByteString.encodeUtf8("move");
Buffer buffer = new Buffer();
buffer.writeUtf8("Don't move! He can't see us if we don't move.");
assertEquals(6, buffer.indexOf(MOVE));
assertEquals(40, buffer.indexOf(MOVE, 12));
indexOf in interface BufferedSourcebytes - ByteStringfromIndex - longIOException - IOException IOException.public long indexOfElement(ByteString targetBytes) throws IOException
indexOfElement in interface BufferedSourcetargetBytes - ByteString
Equivalent to indexOfElement(targetBytes, 0).IOException - IOException IOException.public long indexOfElement(ByteString targetBytes, long fromIndex) throws IOException
indexOfElement in interface BufferedSourcetargetBytes - ByteStringfromIndex - longIOException - IOException IOException.public boolean rangeEquals(long offset,
ByteString bytes)
throws IOException
BufferedSourceoffset in this source equal bytes. This expands
the buffer as necessary until a byte does not match, all bytes are matched, or if the stream
is exhausted before enough bytes could determine a match.
ByteString simonSays = ByteString.encodeUtf8("Simon says:");
Buffer standOnOneLeg = new Buffer().writeUtf8("Simon says: Stand on first leg.");
assertTrue(standOnOneLeg.rangeEquals(0, simonSays));
Buffer payMeMoney = new Buffer().writeUtf8("Pay me $1,000,000.");
assertFalse(payMeMoney.rangeEquals(0, simonSays));
rangeEquals in interface BufferedSourceoffset - longbytes - ByteStringIOException - IOException IOException.public boolean rangeEquals(long offset,
ByteString bytes,
int bytesOffset,
int byteCount)
throws IOException
BufferedSourcebyteCount bytes at offset in this source equal bytes
* at bytesOffset. This expands the buffer as necessary until a byte does not match, all
* bytes are matched, or if the stream is exhausted before enough bytes could determine a match.rangeEquals in interface BufferedSourceoffset - longbytes - ByteStringbytesOffset - intbyteCount - intIOException - IOException IOException.public BufferedSource peek()
BufferedSourceBufferedSource that can read data from this BufferedSource
without consuming it. The returned source becomes invalid once this source is next read or
closed.
For example, we can use peek() to lookahead and read the same data multiple times.
Buffer buffer = new Buffer();
buffer.writeUtf8("abcdefghi");
buffer.readUtf8(3) // returns "abc", buffer contains "defghi"
BufferedSource peek = buffer.peek();
peek.readUtf8(3); // returns "def", buffer contains "defghi"
peek.readUtf8(3); // returns "ghi", buffer contains "defghi"
buffer.readUtf8(3); // returns "def", buffer contains "ghi"
peek in interface BufferedSourcepublic InputStream inputStream()
BufferedSourceinputStream in interface BufferedSourcepublic void close()
throws IOException
Sourceclose in interface Closeableclose in interface AutoCloseableclose in interface Channelclose in interface SourceIOException - IOException IOException.public Timeout timeout()
SourceCopyright © 2019. All rights reserved.