RealBufferedSink

java.lang.Object
- okio.RealBufferedSink

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.nio.channels.Channel, java.nio.channels.WritableByteChannel, BufferedSink, Sink
```
final class RealBufferedSink
extends java.lang.Object
implements BufferedSink
```

Field Summary

Fields
Modifier and Type Field and Description

Buffer buffer

(package private) boolean closed

Sink sink

Fields
Modifier and Type	Field and Description
`Buffer`	`buffer`
`(package private) boolean`	`closed`
`Sink`	`sink`

Constructor Summary

Constructors
Constructor and Description

RealBufferedSink(Sink sink)

Constructors
Constructor and Description
`RealBufferedSink(Sink sink)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Buffer`	`buffer()` Returns this sink's internal buffer.
`void`	`close()` Pushes all buffered bytes to their final destination and releases the resources held by this sink.
`BufferedSink`	`emit()` Writes all buffered data to the underlying sink, if one exists.
`BufferedSink`	`emitCompleteSegments()` Writes complete segments to the underlying sink, if one exists.
`void`	`flush()` Writes all buffered data to the underlying sink, if one exists.
`boolean`	`isOpen()`
`java.io.OutputStream`	`outputStream()` Returns an output stream that writes to this sink.
`Timeout`	`timeout()` Returns the timeout for this sink.
`java.lang.String`	`toString()`
`void`	`write(Buffer source, long byteCount)` Removes `byteCount` bytes from `source` and appends them to this.
`BufferedSink`	`write(byte[] source)` Like `OutputStream.write(byte[])`, this writes a complete byte array to this sink.
`BufferedSink`	`write(byte[] source, int offset, int byteCount)` Like `OutputStream.write(byte[], int, int)`, this writes `byteCount` bytes of `source`, starting at `offset`.
`int`	`write(java.nio.ByteBuffer source)`
`BufferedSink`	`write(ByteString byteString)`
`BufferedSink`	`write(Source source, long byteCount)` Removes `byteCount` bytes from `source` and appends them to this sink.
`long`	`writeAll(Source source)` Removes all bytes from `source` and appends them to this sink.
`BufferedSink`	`writeByte(int b)` Writes a byte to this sink.
`BufferedSink`	`writeDecimalLong(long v)` Writes a long to this sink in signed decimal form (i.e., as a string in base 10).
`BufferedSink`	`writeHexadecimalUnsignedLong(long v)` Writes a long to this sink in hexadecimal form (i.e., as a string in base 16).
`BufferedSink`	`writeInt(int i)` Writes a big-endian int to this sink using four bytes.
`BufferedSink`	`writeIntLe(int i)` Writes a little-endian int to this sink using four bytes.
`BufferedSink`	`writeLong(long v)` Writes a big-endian long to this sink using eight bytes.
`BufferedSink`	`writeLongLe(long v)` Writes a little-endian long to this sink using eight bytes.
`BufferedSink`	`writeShort(int s)` Writes a big-endian short to this sink using two bytes.
`BufferedSink`	`writeShortLe(int s)` Writes a little-endian short to this sink using two bytes.
`BufferedSink`	`writeString(java.lang.String string, java.nio.charset.Charset charset)` Encodes `string` in `charset` and writes it to this sink.
`BufferedSink`	`writeString(java.lang.String string, int beginIndex, int endIndex, java.nio.charset.Charset charset)` Encodes the characters at `beginIndex` up to `endIndex` from `string` in `charset` and writes it to this sink.
`BufferedSink`	`writeUtf8(java.lang.String string)` Encodes `string` in UTF-8 and writes it to this sink.
`BufferedSink`	`writeUtf8(java.lang.String string, int beginIndex, int endIndex)` Encodes the characters at `beginIndex` up to `endIndex` from `string` in UTF-8 and writes it to this sink.
`BufferedSink`	`writeUtf8CodePoint(int codePoint)` Encodes `codePoint` in UTF-8 and writes it to this sink.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

buffer
```
public final Buffer buffer
```

sink
```
public final Sink sink
```

closed
```
boolean closed
```

Constructor Detail
- RealBufferedSink
```
RealBufferedSink(Sink sink)
```

Method Detail

buffer
```
public Buffer buffer()
```
Description copied from interface: BufferedSink

Returns this sink's internal buffer.

Specified by:

buffer in interface BufferedSink

write
```
public void write(Buffer source,
                  long byteCount)
           throws java.io.IOException
```
Description copied from interface: Sink

Removes byteCount bytes from source and appends them to this.

Specified by:

write in interface Sink

Throws:

java.io.IOException

write

public BufferedSink write(ByteString byteString)
                   throws java.io.IOException

Specified by:: write in interface BufferedSink
Throws:: java.io.IOException

writeUtf8

public BufferedSink writeUtf8(java.lang.String string)
                       throws java.io.IOException

Description copied from interface: BufferedSink

Encodes string in UTF-8 and writes it to this sink.



   Buffer buffer = new Buffer();
   buffer.writeUtf8("Uh uh uh!");
   buffer.writeByte(' ');
   buffer.writeUtf8("You didn't say the magic word!");

   assertEquals("Uh uh uh! You didn't say the magic word!", buffer.readUtf8());

Specified by:: writeUtf8 in interface BufferedSink
Throws:: java.io.IOException

writeUtf8

public BufferedSink writeUtf8(java.lang.String string,
                              int beginIndex,
                              int endIndex)
                       throws java.io.IOException

Description copied from interface: BufferedSink

Encodes the characters at beginIndex up to endIndex from string in UTF-8 and writes it to this sink.



   Buffer buffer = new Buffer();
   buffer.writeUtf8("I'm a hacker!\n", 6, 12);
   buffer.writeByte(' ');
   buffer.writeUtf8("That's what I said: you're a nerd.\n", 29, 33);
   buffer.writeByte(' ');
   buffer.writeUtf8("I prefer to be called a hacker!\n", 24, 31);

   assertEquals("hacker nerd hacker!", buffer.readUtf8());

Specified by:: writeUtf8 in interface BufferedSink
Throws:: java.io.IOException

writeUtf8CodePoint
```
public BufferedSink writeUtf8CodePoint(int codePoint)
                                throws java.io.IOException
```
Description copied from interface: BufferedSink

Encodes codePoint in UTF-8 and writes it to this sink.

Specified by:

writeUtf8CodePoint in interface BufferedSink

Throws:

java.io.IOException

writeString

public BufferedSink writeString(java.lang.String string,
                                java.nio.charset.Charset charset)
                         throws java.io.IOException

Description copied from interface: BufferedSink

Encodes string in charset and writes it to this sink.

Specified by:: writeString in interface BufferedSink
Throws:: java.io.IOException

writeString

public BufferedSink writeString(java.lang.String string,
                                int beginIndex,
                                int endIndex,
                                java.nio.charset.Charset charset)
                         throws java.io.IOException

Description copied from interface: BufferedSink

Encodes the characters at beginIndex up to endIndex from string in charset and writes it to this sink.

Specified by:: writeString in interface BufferedSink
Throws:: java.io.IOException

write
```
public BufferedSink write(byte[] source)
                   throws java.io.IOException
```
Description copied from interface: BufferedSink

Like OutputStream.write(byte[]), this writes a complete byte array to this sink.

Specified by:

write in interface BufferedSink

Throws:

java.io.IOException

write
```
public BufferedSink write(byte[] source,
                          int offset,
                          int byteCount)
                   throws java.io.IOException
```
Description copied from interface: BufferedSink

Like OutputStream.write(byte[], int, int), this writes byteCount bytes of source, starting at offset.

Specified by:

write in interface BufferedSink

Throws:

java.io.IOException

write
```
public int write(java.nio.ByteBuffer source)
          throws java.io.IOException
```
Specified by:

write in interface java.nio.channels.WritableByteChannel

Throws:

java.io.IOException

writeAll
```
public long writeAll(Source source)
              throws java.io.IOException
```
Description copied from interface: BufferedSink

Removes all bytes from source and appends them to this sink. Returns the number of bytes read which will be 0 if source is exhausted.

Specified by:

writeAll in interface BufferedSink

Throws:

java.io.IOException

write
```
public BufferedSink write(Source source,
                          long byteCount)
                   throws java.io.IOException
```
Description copied from interface: BufferedSink

Removes byteCount bytes from source and appends them to this sink.

Specified by:

write in interface BufferedSink

Throws:

java.io.IOException

writeByte
```
public BufferedSink writeByte(int b)
                       throws java.io.IOException
```
Description copied from interface: BufferedSink

Writes a byte to this sink.

Specified by:

writeByte in interface BufferedSink

Throws:

java.io.IOException

writeShort

public BufferedSink writeShort(int s)
                        throws java.io.IOException

Description copied from interface: BufferedSink

Writes a big-endian short to this sink using two bytes.



   Buffer buffer = new Buffer();
   buffer.writeShort(32767);
   buffer.writeShort(15);

   assertEquals(4, buffer.size());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeShort in interface BufferedSink
Throws:: java.io.IOException

writeShortLe

public BufferedSink writeShortLe(int s)
                          throws java.io.IOException

Description copied from interface: BufferedSink

Writes a little-endian short to this sink using two bytes.



   Buffer buffer = new Buffer();
   buffer.writeShortLe(32767);
   buffer.writeShortLe(15);

   assertEquals(4, buffer.size());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeShortLe in interface BufferedSink
Throws:: java.io.IOException

writeInt

public BufferedSink writeInt(int i)
                      throws java.io.IOException

Description copied from interface: BufferedSink

Writes a big-endian int to this sink using four bytes.



   Buffer buffer = new Buffer();
   buffer.writeInt(2147483647);
   buffer.writeInt(15);

   assertEquals(8, buffer.size());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeInt in interface BufferedSink
Throws:: java.io.IOException

writeIntLe

public BufferedSink writeIntLe(int i)
                        throws java.io.IOException

Description copied from interface: BufferedSink

Writes a little-endian int to this sink using four bytes.



   Buffer buffer = new Buffer();
   buffer.writeIntLe(2147483647);
   buffer.writeIntLe(15);

   assertEquals(8, buffer.size());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeIntLe in interface BufferedSink
Throws:: java.io.IOException

writeLong

public BufferedSink writeLong(long v)
                       throws java.io.IOException

Description copied from interface: BufferedSink

Writes a big-endian long to this sink using eight bytes.



   Buffer buffer = new Buffer();
   buffer.writeLong(9223372036854775807L);
   buffer.writeLong(15);

   assertEquals(16, buffer.size());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeLong in interface BufferedSink
Throws:: java.io.IOException

writeLongLe

public BufferedSink writeLongLe(long v)
                         throws java.io.IOException

Description copied from interface: BufferedSink

Writes a little-endian long to this sink using eight bytes.



   Buffer buffer = new Buffer();
   buffer.writeLongLe(9223372036854775807L);
   buffer.writeLongLe(15);

   assertEquals(16, buffer.size());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0xff, buffer.readByte());
   assertEquals((byte) 0x7f, buffer.readByte());
   assertEquals((byte) 0x0f, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals((byte) 0x00, buffer.readByte());
   assertEquals(0, buffer.size());

Specified by:: writeLongLe in interface BufferedSink
Throws:: java.io.IOException

writeDecimalLong

public BufferedSink writeDecimalLong(long v)
                              throws java.io.IOException

Description copied from interface: BufferedSink

Writes a long to this sink in signed decimal form (i.e., as a string in base 10).



   Buffer buffer = new Buffer();
   buffer.writeDecimalLong(8675309L);
   buffer.writeByte(' ');
   buffer.writeDecimalLong(-123L);
   buffer.writeByte(' ');
   buffer.writeDecimalLong(1L);

   assertEquals("8675309 -123 1", buffer.readUtf8());

Specified by:: writeDecimalLong in interface BufferedSink
Throws:: java.io.IOException

writeHexadecimalUnsignedLong

public BufferedSink writeHexadecimalUnsignedLong(long v)
                                          throws java.io.IOException

Description copied from interface: BufferedSink

Writes a long to this sink in hexadecimal form (i.e., as a string in base 16).



   Buffer buffer = new Buffer();
   buffer.writeHexadecimalUnsignedLong(65535L);
   buffer.writeByte(' ');
   buffer.writeHexadecimalUnsignedLong(0xcafebabeL);
   buffer.writeByte(' ');
   buffer.writeHexadecimalUnsignedLong(0x10L);

   assertEquals("ffff cafebabe 10", buffer.readUtf8());

Specified by:: writeHexadecimalUnsignedLong in interface BufferedSink
Throws:: java.io.IOException

emitCompleteSegments

public BufferedSink emitCompleteSegments()
                                  throws java.io.IOException

Description copied from interface: BufferedSink

Writes complete segments to the underlying sink, if one exists. Like BufferedSink.flush(), but weaker. Use this to limit the memory held in the buffer to a single segment. Typically application code will not need to call this: it is only necessary when application code writes directly to this sink's buffer.



   BufferedSink b0 = new Buffer();
   BufferedSink b1 = Okio.buffer(b0);
   BufferedSink b2 = Okio.buffer(b1);

   b2.buffer().write(new byte[20_000]);
   assertEquals(20_000, b2.buffer().size());
   assertEquals(     0, b1.buffer().size());
   assertEquals(     0, b0.buffer().size());

   b2.emitCompleteSegments();
   assertEquals( 3_616, b2.buffer().size());
   assertEquals(     0, b1.buffer().size());
   assertEquals(16_384, b0.buffer().size()); // This example assumes 8192 byte segments.

Specified by:: emitCompleteSegments in interface BufferedSink
Throws:: java.io.IOException

emit

public BufferedSink emit()
                  throws java.io.IOException

Description copied from interface: BufferedSink

Writes all buffered data to the underlying sink, if one exists. Like BufferedSink.flush(), but weaker. Call this before this buffered sink goes out of scope so that its data can reach its destination.



   BufferedSink b0 = new Buffer();
   BufferedSink b1 = Okio.buffer(b0);
   BufferedSink b2 = Okio.buffer(b1);

   b2.writeUtf8("hello");
   assertEquals(5, b2.buffer().size());
   assertEquals(0, b1.buffer().size());
   assertEquals(0, b0.buffer().size());

   b2.emit();
   assertEquals(0, b2.buffer().size());
   assertEquals(5, b1.buffer().size());
   assertEquals(0, b0.buffer().size());

   b1.emit();
   assertEquals(0, b2.buffer().size());
   assertEquals(0, b1.buffer().size());
   assertEquals(5, b0.buffer().size());

Specified by:: emit in interface BufferedSink
Throws:: java.io.IOException

outputStream
```
public java.io.OutputStream outputStream()
```
Description copied from interface: BufferedSink

Returns an output stream that writes to this sink.

Specified by:

outputStream in interface BufferedSink

flush

public void flush()
           throws java.io.IOException

Description copied from interface: BufferedSink

Writes all buffered data to the underlying sink, if one exists. Then that sink is recursively flushed which pushes data as far as possible towards its ultimate destination. Typically that destination is a network socket or file.



   BufferedSink b0 = new Buffer();
   BufferedSink b1 = Okio.buffer(b0);
   BufferedSink b2 = Okio.buffer(b1);

   b2.writeUtf8("hello");
   assertEquals(5, b2.buffer().size());
   assertEquals(0, b1.buffer().size());
   assertEquals(0, b0.buffer().size());

   b2.flush();
   assertEquals(0, b2.buffer().size());
   assertEquals(0, b1.buffer().size());
   assertEquals(5, b0.buffer().size());

Specified by:: flush in interface java.io.Flushable
Specified by:: flush in interface BufferedSink
Specified by:: flush in interface Sink
Throws:: java.io.IOException

isOpen
```
public boolean isOpen()
```
Specified by:

isOpen in interface java.nio.channels.Channel

close
```
public void close()
           throws java.io.IOException
```
Description copied from interface: Sink

Pushes all buffered bytes to their final destination and releases the resources held by this sink. It is an error to write a closed sink. It is safe to close a sink more than once.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Specified by:

close in interface Sink

Throws:

java.io.IOException

timeout
```
public Timeout timeout()
```
Description copied from interface: Sink

Returns the timeout for this sink.

Specified by:

timeout in interface Sink

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class RealBufferedSink

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buffer

sink

closed

Constructor Detail

RealBufferedSink

Method Detail

buffer

write

write

writeUtf8

writeUtf8

writeUtf8CodePoint

writeString

writeString

write

write

write

writeAll

write

writeByte

writeShort

writeShortLe

writeInt

writeIntLe

writeLong

writeLongLe

writeDecimalLong

writeHexadecimalUnsignedLong

emitCompleteSegments

emit

outputStream

flush

isOpen

close

timeout

toString