org.apache.hadoop.fs

Interface FSBuilder<S,B extends FSBuilder<S,B>>

Type Parameters:

S - Return type on the build() call.

B - type of builder itself.

All Known Subinterfaces:

FutureDataInputStreamBuilder

All Known Implementing Classes:

AbstractFSBuilderImpl, FSDataOutputStreamBuilder, FutureDataInputStreamBuilderImpl, MultipartUploaderBuilderImpl

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public interface FSBuilder<S,B extends FSBuilder<S,B>>

The base interface which various FileSystem FileContext Builder interfaces can extend, and which underlying implementations will then implement.

Method Summary

Modifier and Type	Method and Description
S	build() Instantiate the object which was being built.
B	must(String key, boolean value) Set mandatory boolean option.
B	must(String key, double value) Set mandatory double option.
B	must(String key, float value) Set mandatory float option.
B	must(String key, int value) Set mandatory int option.
B	must(String key, long value) Set mandatory long option.
B	must(String key, String... values) Set a string array as mandatory option.
B	must(String key, String value) Set mandatory option to the Builder.
B	opt(String key, boolean value) Set optional boolean parameter for the Builder.
B	opt(String key, double value) Set optional double parameter for the Builder.
B	opt(String key, float value) Set optional float parameter for the Builder.
B	opt(String key, int value) Set optional int parameter for the Builder.
B	opt(String key, long value) Set optional long parameter for the Builder.
B	opt(String key, String... values) Set an array of string values as optional parameter for the Builder.
B	opt(String key, String value) Set optional Builder parameter.

Method Detail

opt

B opt(@Nonnull
      String key,
      @Nonnull
      String value)

Set optional Builder parameter.

Parameters:

key - key.

value - value.

Returns:

generic type B.

opt

B opt(@Nonnull
      String key,
      boolean value)

Set optional boolean parameter for the Builder.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

opt(String, String)

opt

B opt(@Nonnull
      String key,
      int value)

Set optional int parameter for the Builder.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

opt(String, String)

opt

B opt(@Nonnull
      String key,
      float value)

Set optional float parameter for the Builder.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

opt(String, String)

opt

B opt(@Nonnull
      String key,
      long value)

Set optional long parameter for the Builder.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

opt(String, String)

opt

B opt(@Nonnull
      String key,
      double value)

Set optional double parameter for the Builder.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

opt(String, String)

opt

B opt(@Nonnull
      String key,
      @Nonnull
      String... values)

Set an array of string values as optional parameter for the Builder.

Parameters:

key - key.

values - values.

Returns:

generic type B.

See Also:

opt(String, String)

must

B must(@Nonnull
       String key,
       @Nonnull
       String value)

Set mandatory option to the Builder. If the option is not supported or unavailable, the client should expect build() throws IllegalArgumentException.

Parameters:

key - key.

value - value.

Returns:

generic type B.

must

B must(@Nonnull
       String key,
       boolean value)

Set mandatory boolean option.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

must(String, String)

must

B must(@Nonnull
       String key,
       int value)

Set mandatory int option.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

must(String, String)

must

B must(@Nonnull
       String key,
       float value)

Set mandatory float option.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

must(String, String)

must

B must(@Nonnull
       String key,
       long value)

Set mandatory long option.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

must(String, String)

must

B must(@Nonnull
       String key,
       double value)

Set mandatory double option.

Parameters:

key - key.

value - value.

Returns:

generic type B.

See Also:

must(String, String)

must

B must(@Nonnull
       String key,
       @Nonnull
       String... values)

Set a string array as mandatory option.

Parameters:

key - key.

values - values.

Returns:

generic type B.

See Also:

must(String, String)

build

S build()
 throws IllegalArgumentException,
        UnsupportedOperationException,
        IOException

Instantiate the object which was being built.

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.