org.apache.paimon.fs

类 PositionOutputStream

java.lang.Object

java.io.OutputStream

org.apache.paimon.fs.PositionOutputStream

所有已实现的接口:

Closeable, Flushable, AutoCloseable

直接已知子类:

LocalFileIO.LocalPositionOutputStream, PositionOutputStreamWrapper

@Public
public abstract class PositionOutputStream
extends OutputStream

PositionOutputStream provides position methods.

从以下版本开始:

0.4.0

构造器概要

构造器

构造器和说明
PositionOutputStream()

方法概要

限定符和类型	方法和说明
abstract void	close() Closes the output stream.
abstract void	flush() Flushes the stream, writing any data currently buffered in stream implementation to the proper output stream.
abstract long	getPos() Gets the position of the stream (non-negative), defined as the number of bytes from the beginning of the file to the current writing position.
abstract void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream.
abstract void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.

从类继承的方法 java.io.OutputStream

write

从类继承的方法 java.lang.Object

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

构造器详细资料

PositionOutputStream

public PositionOutputStream()

方法详细资料

getPos

public abstract long getPos()
                     throws IOException

Gets the position of the stream (non-negative), defined as the number of bytes from the beginning of the file to the current writing position. The position corresponds to the zero-based index of the next byte that will be written.

This method must report accurately report the current position of the stream. Various components of the high-availability and recovery logic rely on the accurate

返回:

The current position in the stream, defined as the number of bytes from the beginning of the file to the current writing position.

抛出:

IOException - Thrown if an I/O error occurs while obtaining the position from the stream implementation.

write

public abstract void write(byte[] b)
                    throws IOException

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

覆盖:

write 在类中 OutputStream

抛出:

IOException

write

public abstract void write(byte[] b,
                           int off,
                           int len)
                    throws IOException

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

覆盖:

write 在类中 OutputStream

抛出:

IOException

flush

public abstract void flush()
                    throws IOException

Flushes the stream, writing any data currently buffered in stream implementation to the proper output stream. After this method has been called, the stream implementation must not hold onto any buffered data any more.

Implementation note: This overrides the method defined in OutputStream as abstract to force implementations of the PositionOutputStream to implement this method directly.

指定者:

flush 在接口中 Flushable

覆盖:

flush 在类中 OutputStream

抛出:

IOException - Thrown if an I/O error occurs while flushing the stream.

close

public abstract void close()
                    throws IOException

Closes the output stream. After this method returns, the implementation must guarantee that all data written to the stream is persistent/visible.

The above implies that the method must block until persistence can be guaranteed. For example for distributed replicated file systems, the method must block until the replication quorum has been reached. If the calling thread is interrupted in the process, it must fail with an IOException to indicate that persistence cannot be guaranteed.

If this method throws an exception, the data in the stream cannot be assumed to be persistent.

Implementation note: This overrides the method defined in OutputStream as abstract to force implementations of the PositionOutputStream to implement this method directly.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 OutputStream

抛出:

IOException - Thrown, if an error occurred while closing the stream or guaranteeing that the data is persistent.