A destination to which bytes can be written, such as a file. Unlike an OutputStream, a ByteSink is not an open, stateful stream that can be written to and closed. Instead, it is an immutable supplier of OutputStream instances.

ByteSink provides two kinds of methods:

Methods that return a stream: These methods should return a new, independent instance each time they are called. The caller is responsible for ensuring that the returned stream is closed.
Convenience methods: These are implementations of common operations that are typically implemented by opening a stream using one of the methods in the first category, doing something and finally closing the stream or channel that was opened.

Modifier and Type	Class and Description
private class	ByteSink.AsCharSink A char sink that encodes written characters with a charset and writes resulting bytes to this byte sink.

Access	Constructor and Description
protected	ByteSink() Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
public CharSink	asCharSink(Charset charset) Returns a `CharSink` view of this `ByteSink` that writes characters to this sink as bytes encoded with the given `charset`.
public OutputStream	openBufferedStream() Opens a new buffered `OutputStream` for writing to this sink.
public abstract OutputStream	openStream() Opens a new `OutputStream` for writing to this sink.
public void	write(byte[] bytes) Writes all the given bytes to this sink.
public long	Returns: the number of bytes written writeFrom(InputStream input) Writes all the bytes from the given `InputStream` to this sink.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

ByteSink	back to summary
protected ByteSink() Constructor for use by subclasses.

Method Detail

asCharSink	back to summary
public CharSink asCharSink(Charset charset) Returns a `CharSink` view of this `ByteSink` that writes characters to this sink as bytes encoded with the given `charset`.

openBufferedStream back to summary

openBufferedStream	back to summary
public OutputStream openBufferedStream() throws IOException Opens a new buffered `OutputStream` for writing to this sink. The returned stream is not required to be a `BufferedOutputStream` in order to allow implementations to simply delegate to `openStream()` when the stream returned by that method does not benefit from additional buffering (for example, a `ByteArrayOutputStream`). This method returns a new, independent stream each time it is called. The caller is responsible for ensuring that the returned stream is closed. Exceptions IOException: if an I/O error occurs while opening the stream Since 15.0 (in 14.0 with return type `BufferedOutputStream`)

public OutputStream openBufferedStream() throws IOException

Opens a new buffered OutputStream for writing to this sink. The returned stream is not required to be a BufferedOutputStream in order to allow implementations to simply delegate to openStream() when the stream returned by that method does not benefit from additional buffering (for example, a ByteArrayOutputStream). This method returns a new, independent stream each time it is called.

The caller is responsible for ensuring that the returned stream is closed.

Exceptions

IOException:: if an I/O error occurs while opening the stream

Since

15.0 (in 14.0 with return type BufferedOutputStream)

openStream back to summary

openStream	back to summary
public abstract OutputStream openStream() throws IOException Opens a new `OutputStream` for writing to this sink. This method returns a new, independent stream each time it is called. The caller is responsible for ensuring that the returned stream is closed. Exceptions IOException: if an I/O error occurs while opening the stream

public abstract OutputStream openStream() throws IOException

Opens a new OutputStream for writing to this sink. This method returns a new, independent stream each time it is called.

The caller is responsible for ensuring that the returned stream is closed.

Exceptions

IOException:: if an I/O error occurs while opening the stream

write	back to summary
public void write(byte[] bytes) throws IOException Writes all the given bytes to this sink. Exceptions IOException: if an I/O occurs while writing to this sink

write

back to summary

public void write(byte[] bytes) throws IOException

Writes all the given bytes to this sink.

Exceptions

IOException:: if an I/O occurs while writing to this sink

writeFrom back to summary

writeFrom	back to summary
public long writeFrom(InputStream input) throws IOException Writes all the bytes from the given `InputStream` to this sink. Does not close `input`. Returns:long the number of bytes written Annotations @CanIgnoreReturnValue Exceptions IOException: if an I/O occurs while reading from `input` or writing to this sink

public long writeFrom(InputStream input) throws IOException

Writes all the bytes from the given InputStream to this sink. Does not close input.

Returns:long

the number of bytes written

Annotations

@CanIgnoreReturnValue

Exceptions

IOException:: if an I/O occurs while reading from input or writing to this sink

com.google.common.io back to summary

private final Class ByteSink.AsCharSink

Class Inheritance

extends CharSink

java.lang.Object
com.google.common.io.CharSink
com.google.common.io.ByteSink.AsCharSink

A char sink that encodes written characters with a charset and writes resulting bytes to this byte sink.

Field Summary

Modifier and Type	Field and Description
private final Charset	charset

Constructor Summary

Access	Constructor and Description
private	AsCharSink(Charset charset)

Method Summary

Modifier and Type	Method and Description
public Writer	openStream() Implements abstract com.google.common.io.CharSink.openStream. Opens a new `Writer` for writing to this sink.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from com.google.common.io.CharSink:: openBufferedStream write writeFrom writeLines writeLines writeLines writeLines

Field Detail

charset	back to summary
private final Charset charset

Constructor Detail

AsCharSink	back to summary
private AsCharSink(Charset charset)

Method Detail

openStream back to summary

openStream	back to summary
public Writer openStream() throws IOException Implements abstract com.google.common.io.CharSink.openStream. Doc from com.google.common.io.CharSink.openStream. Opens a new `Writer` for writing to this sink. This method returns a new, independent writer each time it is called. The caller is responsible for ensuring that the returned writer is closed. Annotations @Override Exceptions IOException: if an I/O error occurs while opening the writer

public Writer openStream() throws IOException

Implements abstract com.google.common.io.CharSink.openStream.

Doc from com.google.common.io.CharSink.openStream.

Opens a new Writer for writing to this sink. This method returns a new, independent writer each time it is called.

The caller is responsible for ensuring that the returned writer is closed.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs while opening the writer

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations