org.apache.hadoop.fs.s3a.impl

Class CreateFileBuilder

java.lang.Object

org.apache.hadoop.fs.impl.AbstractFSBuilderImpl<S,B>

org.apache.hadoop.fs.FSDataOutputStreamBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

org.apache.hadoop.fs.s3a.impl.CreateFileBuilder

All Implemented Interfaces:

org.apache.hadoop.fs.FSBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

public class CreateFileBuilder
extends org.apache.hadoop.fs.FSDataOutputStreamBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

Builder used in create file; takes a callback to the operation to create the file. Is non-recursive unless explicitly changed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFileBuilder.CreateFileBuilderCallbacks Callbacks for creating the file.
static class	CreateFileBuilder.CreateFileOptions Create file options as built from the builder set or the classic entry point.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<org.apache.hadoop.fs.CreateFlag>	CREATE_NO_OVERWRITE_FLAGS Flag set to create without overwrite.
static EnumSet<org.apache.hadoop.fs.CreateFlag>	CREATE_OVERWRITE_FLAGS Flag set to create with overwrite.
static CreateFileBuilder.CreateFileOptions	OPTIONS_CREATE_FILE_NO_OVERWRITE Classic create file option set: no overwrite.
static CreateFileBuilder.CreateFileOptions	OPTIONS_CREATE_FILE_OVERWRITE Classic create file option set: overwriting.
static CreateFileBuilder.CreateFileOptions	OPTIONS_CREATE_FILE_PERFORMANCE Performance create options.

Fields inherited from class org.apache.hadoop.fs.impl.AbstractFSBuilderImpl

UNKNOWN_MANDATORY_KEY

Constructor Summary

Constructors

Constructor and Description
CreateFileBuilder(org.apache.hadoop.fs.FileSystem fileSystem, org.apache.hadoop.fs.Path path, CreateFileBuilder.CreateFileBuilderCallbacks callbacks) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.FSDataOutputStream	build()
EnumSet<org.apache.hadoop.fs.CreateFlag>	getFlags() make the flag getter public.
CreateFileBuilder	getThisBuilder()
CreateFileBuilder	withFlags(EnumSet<org.apache.hadoop.fs.CreateFlag> flags) Pass flags down.

Methods inherited from class org.apache.hadoop.fs.FSDataOutputStreamBuilder

append, blockSize, bufferSize, checksumOpt, create, getBlockSize, getBufferSize, getChecksumOpt, getFS, getPermission, getProgress, getReplication, isRecursive, overwrite, permission, progress, recursive, replication

Methods inherited from class org.apache.hadoop.fs.impl.AbstractFSBuilderImpl

getMandatoryKeys, getOptionalKeys, getOptionalPath, getOptionalPathHandle, getOptions, getPath, getPathHandle, must, must, must, must, must, must, must, mustDouble, mustLong, opt, opt, opt, opt, opt, opt, opt, optDouble, optLong, rejectUnknownMandatoryKeys, rejectUnknownMandatoryKeys

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_OVERWRITE_FLAGS

public static final EnumSet<org.apache.hadoop.fs.CreateFlag> CREATE_OVERWRITE_FLAGS

Flag set to create with overwrite.

CREATE_NO_OVERWRITE_FLAGS

public static final EnumSet<org.apache.hadoop.fs.CreateFlag> CREATE_NO_OVERWRITE_FLAGS

Flag set to create without overwrite.

OPTIONS_CREATE_FILE_OVERWRITE

public static final CreateFileBuilder.CreateFileOptions OPTIONS_CREATE_FILE_OVERWRITE

Classic create file option set: overwriting.

OPTIONS_CREATE_FILE_NO_OVERWRITE

public static final CreateFileBuilder.CreateFileOptions OPTIONS_CREATE_FILE_NO_OVERWRITE

Classic create file option set: no overwrite.

OPTIONS_CREATE_FILE_PERFORMANCE

public static final CreateFileBuilder.CreateFileOptions OPTIONS_CREATE_FILE_PERFORMANCE

Performance create options.

Constructor Detail

CreateFileBuilder

public CreateFileBuilder(@Nonnull
                         org.apache.hadoop.fs.FileSystem fileSystem,
                         @Nonnull
                         org.apache.hadoop.fs.Path path,
                         @Nonnull
                         CreateFileBuilder.CreateFileBuilderCallbacks callbacks)

Constructor.

Parameters:

fileSystem - fs; used by superclass.

path - qualified path to create

callbacks - callbacks.

Method Detail

getThisBuilder

public CreateFileBuilder getThisBuilder()

Overrides:

getThisBuilder in class org.apache.hadoop.fs.FSDataOutputStreamBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

build

public org.apache.hadoop.fs.FSDataOutputStream build()
                                              throws IOException

Specified by:

build in interface org.apache.hadoop.fs.FSBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

Overrides:

build in class org.apache.hadoop.fs.FSDataOutputStreamBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

Throws:

IOException

withFlags

public CreateFileBuilder withFlags(EnumSet<org.apache.hadoop.fs.CreateFlag> flags)

Pass flags down.

Parameters:

flags - input flags.

Returns:

this builder.

getFlags

public EnumSet<org.apache.hadoop.fs.CreateFlag> getFlags()

make the flag getter public.

Overrides:

getFlags in class org.apache.hadoop.fs.FSDataOutputStreamBuilder<org.apache.hadoop.fs.FSDataOutputStream,CreateFileBuilder>

Returns:

creation flags.