Package com.clickhouse.client.stream

Class AbstractByteBufferInputStream

java.lang.Object

java.io.InputStream

com.clickhouse.client.ClickHouseInputStream

com.clickhouse.client.stream.AbstractByteBufferInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BlockingInputStream, IterableByteBufferInputStream

public abstract class AbstractByteBufferInputStream
extends ClickHouseInputStream

ByteBuffer backed input stream.

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteBuffer	buffer

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractByteBufferInputStream(ClickHouseFile file, OutputStream copyTo, Runnable postCloseAction)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
protected void	ensureOpen()	Checks whether the input stream has been closed and throw an exception if it is.
int	peek()	Peeks one byte.
long	pipe(ClickHouseOutputStream output)	Reads all remaining bytes and write into given output stream.
int	read()
int	read(byte[] b, int off, int len)
ClickHouseByteBuffer	readBuffer(int length)	Reads byte buffer from the input stream.
byte	readByte()	Reads one single byte from the input stream.
byte[]	readBytes(int length)	Reads length bytes from the input stream.
ClickHouseByteBuffer	readCustom(ClickHouseDataUpdater reader)	Reads bytes using custom reader.
long	skip(long n)
protected abstract int	updateBuffer()	Update inner buffer as needed.

Methods inherited from class com.clickhouse.client.ClickHouseInputStream

closeQuietly, empty, getUnderlyingFile, isClosed, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, of, pipe, pipe, readAsciiString, readAsciiString, readString, readString, readUnicodeString, readUnicodeString, readUnsignedByte, readVarInt, readVarLong, save, save, setCopyToTarget, wrap

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, 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

buffer

protected ByteBuffer buffer

Constructor Detail

AbstractByteBufferInputStream

protected AbstractByteBufferInputStream(ClickHouseFile file,
                                        OutputStream copyTo,
                                        Runnable postCloseAction)

Method Detail

ensureOpen

protected void ensureOpen()
                   throws IOException

Description copied from class: ClickHouseInputStream

Checks whether the input stream has been closed and throw an exception if it is.

Overrides:

ensureOpen in class ClickHouseInputStream

Throws:

IOException - when the input stream has been closed

updateBuffer

protected abstract int updateBuffer()
                             throws IOException

Update inner buffer as needed.

Returns:

remaining bytes in buffer

Throws:

IOException - when failed to update buffer

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

readBuffer

public ClickHouseByteBuffer readBuffer(int length)
                                throws IOException

Description copied from class: ClickHouseInputStream

Reads byte buffer from the input stream.

Overrides:

readBuffer in class ClickHouseInputStream

Parameters:

length - byte length

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

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

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

readBytes

public byte[] readBytes(int length)
                 throws IOException

Description copied from class: ClickHouseInputStream

Reads length bytes from the input stream. It behaves in the same way as DataInput.readFully(byte[]), except it will throw IOException when the input stream has been closed.

Overrides:

readBytes in class ClickHouseInputStream

Parameters:

length - number of bytes to read

Returns:

byte array and its length should be length

Throws:

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

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException