org.apache.hadoop.fs

Class FSDataOutputStreamBuilder<S extends FSDataOutputStream,B extends FSDataOutputStreamBuilder<S,B>>

java.lang.Object

org.apache.hadoop.fs.FSDataOutputStreamBuilder<S,B>

@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class FSDataOutputStreamBuilder<S extends FSDataOutputStream,B extends FSDataOutputStreamBuilder<S,B>>
extends Object

Builder for FSDataOutputStream and its subclasses. It is used to create FSDataOutputStream when creating a new file or appending an existing file on FileSystem. By default, it does not create parent directory that do not exist. FileSystem.createNonRecursive(Path, boolean, int, short, long, Progressable). To create missing parent directory, use recursive().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FSDataOutputStreamBuilder(FileSystem fileSystem, Path p) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
B	append() Append to an existing file (optional operation).
B	blockSize(long blkSize) Set block size.
B	bufferSize(int bufSize) Set the size of the buffer to be used.
abstract S	build() Create the FSDataOutputStream to write on the file system.
B	checksumOpt(Options.ChecksumOpt chksumOpt) Set checksum opt.
B	create() Create an FSDataOutputStream at the specified path.
protected long	getBlockSize()
protected int	getBufferSize()
protected Options.ChecksumOpt	getChecksumOpt()
protected EnumSet<CreateFlag>	getFlags()
protected FileSystem	getFS()
protected Path	getPath()
protected FsPermission	getPermission()
protected Progressable	getProgress()
protected short	getReplication()
protected abstract B	getThisBuilder() Return the concrete implementation of the builder instance.
protected boolean	isRecursive() Return true to create the parent directories if they do not exist.
B	overwrite(boolean overwrite) Set to true to overwrite the existing file.
B	permission(FsPermission perm) Set permission for the file.
B	progress(Progressable prog) Set the facility of reporting progress.
B	recursive() Create the parent directory if they do not exist.
B	replication(short replica) Set replication factor.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSDataOutputStreamBuilder

protected FSDataOutputStreamBuilder(@Nonnull
                         FileSystem fileSystem,
                         @Nonnull
                         Path p)

Constructor.

Method Detail

getThisBuilder

protected abstract B getThisBuilder()

Return the concrete implementation of the builder instance.

getFS

protected FileSystem getFS()

getPath

protected Path getPath()

getPermission

protected FsPermission getPermission()

permission

public B permission(@Nonnull
           FsPermission perm)

Set permission for the file.

getBufferSize

protected int getBufferSize()

bufferSize

public B bufferSize(int bufSize)

Set the size of the buffer to be used.

getReplication

protected short getReplication()

replication

public B replication(short replica)

Set replication factor.

getBlockSize

protected long getBlockSize()

blockSize

public B blockSize(long blkSize)

Set block size.

isRecursive

protected boolean isRecursive()

Return true to create the parent directories if they do not exist.

recursive

public B recursive()

Create the parent directory if they do not exist.

getProgress

protected Progressable getProgress()

progress

public B progress(@Nonnull
         Progressable prog)

Set the facility of reporting progress.

getFlags

protected EnumSet<CreateFlag> getFlags()

create

public B create()

Create an FSDataOutputStream at the specified path.

overwrite

public B overwrite(boolean overwrite)

Set to true to overwrite the existing file. Set it to false, an exception will be thrown when calling build() if the file exists.

append

public B append()

Append to an existing file (optional operation).

getChecksumOpt

protected Options.ChecksumOpt getChecksumOpt()

checksumOpt

public B checksumOpt(@Nonnull
            Options.ChecksumOpt chksumOpt)

Set checksum opt.

build

public abstract S build()
                                            throws IOException

Create the FSDataOutputStream to write on the file system.

Throws:

HadoopIllegalArgumentException - if the parameters are not valid.

IOException - on errors when file system creates or appends the file.