Package com.clickhouse.client.stream

Class EmptyOutputStream

java.lang.Object

java.io.OutputStream

com.clickhouse.client.ClickHouseOutputStream

com.clickhouse.client.stream.EmptyOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class EmptyOutputStream
extends ClickHouseOutputStream

Empty output stream consumes nothing and it can never be closed.

Field Summary

Fields

Modifier and Type	Field	Description
static EmptyOutputStream	INSTANCE

Fields inherited from class com.clickhouse.client.ClickHouseOutputStream

closed, ERROR_INCOMPLETE_READ, ERROR_NULL_BYTES, ERROR_REUSE_BUFFER, ERROR_STREAM_CLOSED, file, postCloseAction

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isClosed()	Checks if the output stream has been closed or not.
ClickHouseOutputStream	transferBytes(byte[] bytes, int offset, int length)	Transfers the given bytes into output stream, without creating a copy as in ClickHouseOutputStream.writeBytes(byte[], int, int).
ClickHouseOutputStream	writeByte(byte b)	Writes a single byte into output stream.
ClickHouseOutputStream	writeBytes(byte[] bytes, int offset, int length)	Writes copy of given bytes into output stream.
ClickHouseOutputStream	writeCustom(ClickHouseDataUpdater writer)	Writes bytes using custom writer.

Methods inherited from class com.clickhouse.client.ClickHouseOutputStream

empty, ensureOpen, getUnderlyingFile, of, of, of, of, transferBytes, transferBytes, write, write, write, writeAsciiString, writeBuffer, writeBytes, writeBytes, writeString, writeUnicodeString, writeUnsignedVarInt, writeVarInt

Methods inherited from class java.io.OutputStream

flush, nullOutputStream

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final EmptyOutputStream INSTANCE

Method Detail

isClosed

public boolean isClosed()

Description copied from class: ClickHouseOutputStream

Checks if the output stream has been closed or not.

Overrides:

isClosed in class ClickHouseOutputStream

Returns:

true if the output stream has been closed; false otherwise

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ClickHouseOutputStream

Throws:

IOException

transferBytes

public ClickHouseOutputStream transferBytes(byte[] bytes,
                                            int offset,
                                            int length)
                                     throws IOException

Description copied from class: ClickHouseOutputStream

Transfers the given bytes into output stream, without creating a copy as in ClickHouseOutputStream.writeBytes(byte[], int, int).

Specified by:

transferBytes in class ClickHouseOutputStream

Parameters:

bytes - non-null byte array

offset - offset of the byte array

length - bytes to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeByte

public ClickHouseOutputStream writeByte(byte b)
                                 throws IOException

Description copied from class: ClickHouseOutputStream

Writes a single byte into output stream.

Specified by:

writeByte in class ClickHouseOutputStream

Parameters:

b - byte to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeBytes

public ClickHouseOutputStream writeBytes(byte[] bytes,
                                         int offset,
                                         int length)
                                  throws IOException

Description copied from class: ClickHouseOutputStream

Writes copy of given bytes into output stream.

Specified by:

writeBytes in class ClickHouseOutputStream

Parameters:

bytes - non-null byte array

offset - offset of the byte array

length - bytes to write

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream

writeCustom

public ClickHouseOutputStream writeCustom(ClickHouseDataUpdater writer)
                                   throws IOException

Description copied from class: ClickHouseOutputStream

Writes bytes using custom writer.

Specified by:

writeCustom in class ClickHouseOutputStream

Parameters:

writer - non-null data writer

Returns:

current output stream

Throws:

IOException - when failed to write value into output stream, not able to sent all bytes, or opereate on a closed stream