alluxio.client.file

Class FileOutStream

java.lang.Object

java.io.OutputStream

alluxio.client.file.FileOutStream

All Implemented Interfaces:

Cancelable, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

AlluxioFileOutStream

@PublicApi
 @NotThreadSafe
public abstract class FileOutStream
extends OutputStream
implements Cancelable

An abstraction of the output stream API in Alluxio to write data to a file or a block. In addition to extending abstract class OutputStream as the basics, it also keeps counting the number of bytes written to the output stream, and extends Cancelable to abort the writes.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	mBytesWritten The number of bytes written.

Constructor Summary

Constructors

Constructor and Description
FileOutStream()

Method Summary

Modifier and Type	Method and Description
void	cancel() Aborts the output stream.
int	getBytesWritten() Deprecated. this method will not work if more than MAX_INT bytes are written; to get a count of bytes written, wrap this stream in a counting output stream such as org.apache.commons.io.output.CountingOutputStream

Methods inherited from class java.io.OutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

mBytesWritten

protected long mBytesWritten

The number of bytes written.

Constructor Detail

FileOutStream

public FileOutStream()

Method Detail

getBytesWritten

@Deprecated
public int getBytesWritten()

Deprecated. this method will not work if more than MAX_INT bytes are written; to get a count of bytes written, wrap this stream in a counting output stream such as org.apache.commons.io.output.CountingOutputStream

Returns:

the number of bytes written to this stream

cancel

public void cancel()
            throws IOException

Aborts the output stream.

Specified by:

cancel in interface Cancelable

Throws:

IOException