S - Return type on the build() call.B - type of builder itself.@InterfaceAudience.Public
@InterfaceStability.Unstable
public interface FSBuilder<S,B extends FSBuilder<S,B>>
| 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.
|
B opt(@Nonnull String key, @Nonnull String value)
key - key.value - value.B opt(@Nonnull String key, boolean value)
key - key.value - value.opt(String, String)B opt(@Nonnull String key, int value)
key - key.value - value.opt(String, String)B opt(@Nonnull String key, float value)
key - key.value - value.opt(String, String)B opt(@Nonnull String key, long value)
key - key.value - value.opt(String, String)B opt(@Nonnull String key, double value)
key - key.value - value.opt(String, String)B opt(@Nonnull String key, @Nonnull String... values)
key - key.values - values.opt(String, String)B must(@Nonnull String key, @Nonnull String value)
build() throws IllegalArgumentException.key - key.value - value.B must(@Nonnull String key, boolean value)
key - key.value - value.must(String, String)B must(@Nonnull String key, int value)
key - key.value - value.must(String, String)B must(@Nonnull String key, float value)
key - key.value - value.must(String, String)B must(@Nonnull String key, long value)
key - key.value - value.must(String, String)B must(@Nonnull String key, double value)
key - key.value - value.must(String, String)B must(@Nonnull String key, @Nonnull String... values)
key - key.values - values.must(String, String)S build() throws IllegalArgumentException, UnsupportedOperationException, IOException
IllegalArgumentException - if the parameters are not valid.UnsupportedOperationException - if the filesystem does not support
the specific operation.IOException - on filesystem IO errors.Copyright © 2023 Apache Software Foundation. All rights reserved.