alluxio.client.file

Class FileOutStream

java.lang.Object

java.io.OutputStream

alluxio.client.AbstractOutStream

alluxio.client.file.FileOutStream

All Implemented Interfaces:

Cancelable, Closeable, Flushable, AutoCloseable

@PublicApi
 @NotThreadSafe
public class FileOutStream
extends AbstractOutStream

Provides a streaming API to write a file. This class wraps the BlockOutStreams for each of the blocks in the file and abstracts the switching between streams. The backing streams can write to Alluxio space in the local machine or remote machines. If the UnderStorageType is UnderStorageType.SYNC_PERSIST, another stream will write the data to the under storage system.

Field Summary

Fields

Modifier and Type	Field and Description
protected AlluxioURI	mUri

Fields inherited from class alluxio.client.AbstractOutStream

mBytesWritten

Constructor Summary

Constructors

Constructor and Description
FileOutStream(AlluxioURI path, OutStreamOptions options, FileSystemContext context) Creates a new file output stream.

Method Summary

Modifier and Type	Method and Description
void	cancel() Aborts the output stream.
void	close()
void	flush()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class alluxio.client.AbstractOutStream

getBytesWritten

Methods inherited from class java.lang.Object

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

Field Detail

mUri

protected final AlluxioURI mUri

Constructor Detail

FileOutStream

public FileOutStream(AlluxioURI path,
                     OutStreamOptions options,
                     FileSystemContext context)
              throws IOException

Creates a new file output stream.

Parameters:

path - the file path

options - the client options

context - the file system context

Throws:

IOException

Method Detail

cancel

public void cancel()
            throws IOException

Description copied from class: AbstractOutStream

Aborts the output stream.

Specified by:

cancel in interface Cancelable

Overrides:

cancel in class AbstractOutStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException