Package com.clickhouse.client.stream

Class EmptyInputStream

java.lang.Object

java.io.InputStream

com.clickhouse.client.ClickHouseInputStream

com.clickhouse.client.stream.EmptyInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class EmptyInputStream
extends ClickHouseInputStream

Empty input stream produces nothing and it can never be closed.

Field Summary

Fields

Modifier and Type	Field	Description
static EmptyInputStream	INSTANCE

Fields inherited from class com.clickhouse.client.ClickHouseInputStream

byteBuffer, closed, copyTo, EMPTY_BUFFER, EMPTY_BYTES, ERROR_INCOMPLETE_READ, ERROR_NULL_BYTES, ERROR_REUSE_BUFFER, ERROR_STREAM_CLOSED, file, postCloseAction

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
boolean	isClosed()	Checks if the input stream has been closed or not.
int	peek()	Peeks one byte.
long	pipe(ClickHouseOutputStream output)	Reads all remaining bytes and write into given output stream.
int	read()
byte	readByte()	Reads one single byte from the input stream.
ClickHouseByteBuffer	readCustom(ClickHouseDataUpdater reader)	Reads bytes using custom reader.
long	skip(long n)

Methods inherited from class com.clickhouse.client.ClickHouseInputStream

closeQuietly, empty, ensureOpen, getUnderlyingFile, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, pipe, pipe, readAsciiString, readAsciiString, readBuffer, readBytes, readString, readString, readUnicodeString, readUnicodeString, readUnsignedByte, readVarInt, readVarLong, save, save, setCopyToTarget, wrap

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, transferTo

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final EmptyInputStream INSTANCE

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ClickHouseInputStream

Throws:

IOException

peek

public int peek()
         throws IOException

Description copied from class: ClickHouseInputStream

Peeks one byte. It's similar as InputStream.read() except it never changes cursor.

Specified by:

peek in class ClickHouseInputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached

Throws:

IOException - when failed to read value from input stream or reached end of the stream

pipe

public long pipe(ClickHouseOutputStream output)
          throws IOException

Description copied from class: ClickHouseInputStream

Reads all remaining bytes and write into given output stream. Current input stream will be closed automatically at the end of writing, but output will remain open.

Specified by:

pipe in class ClickHouseInputStream

Parameters:

output - non-null output stream

Returns:

bytes being written into output stream

Throws:

IOException - when failed to read value from input stream or reached end of the stream

readByte

public byte readByte()
              throws IOException

Description copied from class: ClickHouseInputStream

Reads one single byte from the input stream. Unlike InputStream.read(), it will throw IOException if the input stream has been closed. In general, this method should be faster than InputStream.read(), especially when it's an input stream backed by byte[] or ByteBuffer.

Specified by:

readByte in class ClickHouseInputStream

Returns:

byte value if present

Throws:

IOException - when failed to read value from input stream or reached end of the stream

readCustom

public ClickHouseByteBuffer readCustom(ClickHouseDataUpdater reader)
                                throws IOException

Description copied from class: ClickHouseInputStream

Reads bytes using custom reader. Stream will be closed automatically when it reached end of stream. However, unlike ClickHouseInputStream.readBuffer(int), this method will never throw EOFException.

Specified by:

readCustom in class ClickHouseInputStream

Parameters:

reader - non-null data reader

Returns:

non-null byte buffer

Throws:

IOException - when failed to read bytes from input stream, not able to retrieve all bytes, or reached end of the stream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

isClosed

public boolean isClosed()

Description copied from class: ClickHouseInputStream

Checks if the input stream has been closed or not.

Overrides:

isClosed in class ClickHouseInputStream

Returns:

true if the input stream has been closed; false otherwise

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException