Fluent builder for a QueryParameter, created via QueryParameter.newQueryParameterBuilder with the parameter's name and type, then configured with an optional title, description and optional flag before calling build.
Group: Builders
Methods
build(List<QueryParameter> list)
Returns: QueryParameter
Builds the QueryParameter from this builder's configured values. If no title was set, it is derived from the parameter's name. If a list is given, the built parameter is appended to it.
| Parameter | Description |
|---|---|
list | a list to append the built parameter to, or null to skip appending |
title(String s)
Returns: QueryParameterBuilder
Sets the human-readable display title for the parameter being built.
| Parameter | Description |
|---|---|
s | the display title to use |
description(String s)
Returns: QueryParameterBuilder
Sets the longer, human-readable description for the parameter being built.
| Parameter | Description |
|---|---|
s | the description to use |
optional(boolean s)
Returns: QueryParameterBuilder
Sets whether the parameter being built may be omitted when running a query.
| Parameter | Description |
|---|---|
s | true if the parameter is optional, false if it must be supplied |