org.apache.hadoop.fs

Interface FutureDataInputStreamBuilder

All Superinterfaces:

FSBuilder<CompletableFuture<FSDataInputStream>,FutureDataInputStreamBuilder>

All Known Implementing Classes:

FutureDataInputStreamBuilderImpl

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public interface FutureDataInputStreamBuilder
extends FSBuilder<CompletableFuture<FSDataInputStream>,FutureDataInputStreamBuilder>

Builder for input streams and subclasses whose return value is actually a completable future: this allows for better asynchronous operation. To be more generic, FSBuilder.opt(String, int) and FSBuilder.must(String, int) variants provide implementation-agnostic way to customize the builder. Each FS-specific builder implementation can interpret the FS-specific options accordingly, for example: If the option is not related to the file system, the option will be ignored. If the option is must, but not supported/known by the file system, an IllegalArgumentException will be thrown.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<FSDataInputStream>	build() Instantiate the object which was being built.
default FutureDataInputStreamBuilder	withFileStatus(FileStatus status) A FileStatus may be provided to the open request.

Methods inherited from interface org.apache.hadoop.fs.FSBuilder

must, must, must, must, must, must, must, opt, opt, opt, opt, opt, opt, opt

Method Detail

build

CompletableFuture<FSDataInputStream> build()
                                    throws IllegalArgumentException,
                                           UnsupportedOperationException,
                                           IOException

Description copied from interface: FSBuilder

Instantiate the object which was being built.

Specified by:

build in interface FSBuilder<CompletableFuture<FSDataInputStream>,FutureDataInputStreamBuilder>

Returns:

generic type S.

Throws:

IllegalArgumentException - if the parameters are not valid.

UnsupportedOperationException - if the filesystem does not support the specific operation.

IOException - on filesystem IO errors.

withFileStatus

default FutureDataInputStreamBuilder withFileStatus(@Nullable
                                                    FileStatus status)

A FileStatus may be provided to the open request. It is up to the implementation whether to use this or not.

Parameters:

status - status: may be null

Returns:

the builder.