Package okio

Class ForwardingSink

java.lang.Object

okio.ForwardingSink

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Sink

public abstract class ForwardingSink
extends Object
implements Sink

A Sink which forwards calls to another. Useful for subclassing.

Constructor Summary

Constructors

Constructor	Description
ForwardingSink(Sink delegate)

Method Summary

Modifier and Type	Method	Description
void	close()	Pushes all buffered bytes to their final destination and releases the resources held by this sink.
Sink	delegate()	Sink to which this instance is delegating.
void	flush()	Pushes all buffered bytes to their final destination.
Timeout	timeout()	Returns the timeout for this sink.
String	toString()	Returns a string containing a concise, human-readable description of this object.
void	write(Buffer source, long byteCount)	Removes byteCount bytes from source and appends them to this.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingSink

public ForwardingSink(Sink delegate)

Method Detail

delegate

public final Sink delegate()

Sink to which this instance is delegating.

write

public void write(Buffer source,
                  long byteCount)
           throws IOException

Description copied from interface: Sink

Removes byteCount bytes from source and appends them to this.

Specified by:

write in interface Sink

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: Sink

Pushes all buffered bytes to their final destination.

Specified by:

flush in interface Flushable

Specified by:

flush in interface Sink

Throws:

IOException - if there are any issues writing the data.

timeout

public Timeout timeout()

Description copied from interface: Sink

Returns the timeout for this sink.

Specified by:

timeout in interface Sink

close

public void close()
           throws 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 AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Sink

Throws:

IOException

toString

public String toString()

Description copied from class: Object

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.