@ProviderType
public static interface Form.Builder.FieldStep<T>
Modifier and Type | Method and Description |
---|---|
Form.Builder.FieldStep<T> |
addOptionalBoolean(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Boolean> biConsumer)
Requests an optional boolean from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalBooleanList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Boolean>> biConsumer)
Requests an optional boolean list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalDate(java.lang.String key,
java.util.function.BiConsumer<T,java.util.Date> biConsumer)
Requests an optional date from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalDateList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.util.Date>> biConsumer)
Requests an optional date list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalDouble(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Double> biConsumer)
Requests an optional double from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalDoubleList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Double>> biConsumer)
Requests an optional double list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalFile(java.lang.String key,
java.util.function.BiConsumer<T,BinaryFile> biConsumer)
Requests an optional file from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalFileList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<BinaryFile>> biConsumer)
Requests an optional file list from the HTTP request body.
|
<C> Form.Builder.FieldStep<T> |
addOptionalLinkedModel(java.lang.String key,
java.lang.Class<? extends Identifier<C>> aClass,
java.util.function.BiConsumer<T,C> biConsumer)
Requests an optional linked model from the HTTP request body.
|
<C> Form.Builder.FieldStep<T> |
addOptionalLinkedModelList(java.lang.String key,
java.lang.Class<? extends Identifier<C>> aClass,
java.util.function.BiConsumer<T,java.util.List<C>> biConsumer)
Requests an optional list of linked models from the HTTP request
body.
|
Form.Builder.FieldStep<T> |
addOptionalLong(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Long> biConsumer)
Requests an optional long from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalLongList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Long>> biConsumer)
Requests an optional long list from the HTTP request body.
|
<U> Form.Builder.FieldStep<T> |
addOptionalNestedModel(java.lang.String key,
FormBuilderFunction<U> formBuilderFunction,
java.util.function.BiConsumer<T,U> biConsumer)
Requests an optional nested model from the HTTP request body.
|
<U> Form.Builder.FieldStep<T> |
addOptionalNestedModelList(java.lang.String key,
FormBuilderFunction<U> formBuilderFunction,
java.util.function.BiConsumer<T,java.util.List<U>> biConsumer)
Requests an optional nested model list from the HTTP request
body.
|
Form.Builder.FieldStep<T> |
addOptionalString(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.String> biConsumer)
Requests an optional string from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addOptionalStringList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.String>> biConsumer)
Requests an optional string list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredBoolean(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Boolean> biConsumer)
Requests a mandatory boolean from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredBooleanList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Boolean>> biConsumer)
Requests a mandatory boolean list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredDate(java.lang.String key,
java.util.function.BiConsumer<T,java.util.Date> biConsumer)
Requests a mandatory date from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredDateList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.util.Date>> biConsumer)
Requests a mandatory date list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredDouble(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Double> biConsumer)
Requests a mandatory double from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredDoubleList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Double>> biConsumer)
Requests a mandatory double list from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredFile(java.lang.String key,
java.util.function.BiConsumer<T,BinaryFile> biConsumer)
Requests a mandatory file from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredFileList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<BinaryFile>> biConsumer)
Requests a mandatory file list from the HTTP request body.
|
<C> Form.Builder.FieldStep<T> |
addRequiredLinkedModel(java.lang.String key,
java.lang.Class<? extends Identifier<C>> aClass,
java.util.function.BiConsumer<T,C> biConsumer)
Requests a mandatory linked model from the HTTP request body.
|
<C> Form.Builder.FieldStep<T> |
addRequiredLinkedModelList(java.lang.String key,
java.lang.Class<? extends Identifier<C>> aClass,
java.util.function.BiConsumer<T,java.util.List<C>> biConsumer)
Requests a mandatory list of linked models from the HTTP request
body.
|
Form.Builder.FieldStep<T> |
addRequiredLong(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.Long> biConsumer)
Requests a mandatory long from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredLongList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.Long>> biConsumer)
Requests a mandatory long list from the HTTP request body.
|
<U> Form.Builder.FieldStep<T> |
addRequiredNestedModel(java.lang.String key,
FormBuilderFunction<U> formBuilderFunction,
java.util.function.BiConsumer<T,U> biConsumer)
Requests a mandatory nested model from the HTTP request body.
|
<U> Form.Builder.FieldStep<T> |
addRequiredNestedModelList(java.lang.String key,
FormBuilderFunction<U> formBuilderFunction,
java.util.function.BiConsumer<T,java.util.List<U>> biConsumer)
Requests a mandatory nested model list from the HTTP request
body.
|
Form.Builder.FieldStep<T> |
addRequiredString(java.lang.String key,
java.util.function.BiConsumer<T,java.lang.String> biConsumer)
Requests a mandatory string from the HTTP request body.
|
Form.Builder.FieldStep<T> |
addRequiredStringList(java.lang.String key,
java.util.function.BiConsumer<T,java.util.List<java.lang.String>> biConsumer)
Requests a mandatory string list from the HTTP request body.
|
Form<T> |
build()
Creates and returns the
Form instance, using the
information provided to the builder. |
Form.Builder.FieldStep<T> addOptionalBoolean(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Boolean> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a boolean.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalBooleanList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Boolean>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a boolean list.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalDate(java.lang.String key, java.util.function.BiConsumer<T,java.util.Date> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a date.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalDateList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.util.Date>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a date list.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalDouble(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Double> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a double.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalDoubleList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Double>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a double list.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalFile(java.lang.String key, java.util.function.BiConsumer<T,BinaryFile> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a file.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalFileList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<BinaryFile>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a file list.
key
- the field's keybiConsumer
- the consumer to call if the field is found<C> Form.Builder.FieldStep<T> addOptionalLinkedModel(java.lang.String key, java.lang.Class<? extends Identifier<C>> aClass, java.util.function.BiConsumer<T,C> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a linked model.
key
- the field's keyaClass
- the identifier class to extract and return the
class IDbiConsumer
- the consumer to call<C> Form.Builder.FieldStep<T> addOptionalLinkedModelList(java.lang.String key, java.lang.Class<? extends Identifier<C>> aClass, java.util.function.BiConsumer<T,java.util.List<C>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a linked model
list.
key
- the field's keyaClass
- the identifier class to extract and return the
class IDbiConsumer
- the consumer to callForm.Builder.FieldStep<T> addOptionalLong(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Long> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a long.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalLongList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Long>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a long list.
key
- the field's keybiConsumer
- the consumer to call if the field is found<U> Form.Builder.FieldStep<T> addOptionalNestedModel(java.lang.String key, FormBuilderFunction<U> formBuilderFunction, java.util.function.BiConsumer<T,U> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a nested model.
key
- the field's keyformBuilderFunction
- the function that builds the formbiConsumer
- the consumer to call if the field is found<U> Form.Builder.FieldStep<T> addOptionalNestedModelList(java.lang.String key, FormBuilderFunction<U> formBuilderFunction, java.util.function.BiConsumer<T,java.util.List<U>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a nested model list.
key
- the field's keyformBuilderFunction
- the function that builds the formbiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalString(java.lang.String key, java.util.function.BiConsumer<T,java.lang.String> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a string.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addOptionalStringList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.String>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a string list.
key
- the field's keybiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addRequiredBoolean(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Boolean> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a boolean.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredBooleanList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Boolean>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a boolean list.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredDate(java.lang.String key, java.util.function.BiConsumer<T,java.util.Date> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a date.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredDateList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.util.Date>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a date list.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredDouble(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Double> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a double.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredDoubleList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Double>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a double list.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredFile(java.lang.String key, java.util.function.BiConsumer<T,BinaryFile> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a file.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredFileList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<BinaryFile>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a file list.
key
- the field's keybiConsumer
- the consumer to call<C> Form.Builder.FieldStep<T> addRequiredLinkedModel(java.lang.String key, java.lang.Class<? extends Identifier<C>> aClass, java.util.function.BiConsumer<T,C> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a required
linked model.
key
- the field's keyaClass
- the identifier class to extract and return the
class IDbiConsumer
- the consumer to call<C> Form.Builder.FieldStep<T> addRequiredLinkedModelList(java.lang.String key, java.lang.Class<? extends Identifier<C>> aClass, java.util.function.BiConsumer<T,java.util.List<C>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a required
linked model list.
key
- the field's keyaClass
- the identifier class to extract and return the
class IDbiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredLong(java.lang.String key, java.util.function.BiConsumer<T,java.lang.Long> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a long.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredLongList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.Long>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a long list.
key
- the field's keybiConsumer
- the consumer to call<U> Form.Builder.FieldStep<T> addRequiredNestedModel(java.lang.String key, FormBuilderFunction<U> formBuilderFunction, java.util.function.BiConsumer<T,U> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a nested model.
key
- the field's keyformBuilderFunction
- the function that builds the formbiConsumer
- the consumer to call if the field is found<U> Form.Builder.FieldStep<T> addRequiredNestedModelList(java.lang.String key, FormBuilderFunction<U> formBuilderFunction, java.util.function.BiConsumer<T,java.util.List<U>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value, if the field is present. A BadRequestException
is thrown if the field is found but it isn't
a nested model list.
key
- the field's keyformBuilderFunction
- the function that builds the formbiConsumer
- the consumer to call if the field is foundForm.Builder.FieldStep<T> addRequiredString(java.lang.String key, java.util.function.BiConsumer<T,java.lang.String> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a string.
key
- the field's keybiConsumer
- the consumer to callForm.Builder.FieldStep<T> addRequiredStringList(java.lang.String key, java.util.function.BiConsumer<T,java.util.List<java.lang.String>> biConsumer)
This method calls the provided consumer with the store instance
(provided with the Form.Builder.ConstructorStep.constructor(java.util.function.Supplier<T>)
method)
and the field value. A BadRequestException
is thrown if
the field isn't found, or it's found but it isn't a string list.
key
- the field's keybiConsumer
- the consumer to call