Package com.polarion.alm.shared.api.model.rp.parameter

Interface CustomEnumParameter.Builder

All Superinterfaces:

CustomEnumParameter.Setter, RichPageParameter.Builder<CustomEnumParameter,CustomEnumParameter.Builder>

Enclosing interface:

CustomEnumParameter

public static interface CustomEnumParameter.Builder
extends CustomEnumParameter.Setter, RichPageParameter.Builder<CustomEnumParameter,CustomEnumParameter.Builder>

Method Summary

Modifier and Type	Method	Description
CustomEnumParameter.Builder	addEnumItem(String value, String label)	Adds an enumeration item.
CustomEnumParameter.Builder	allowMultipleValues(boolean value)
CustomEnumParameter.Builder	allowNoValue(boolean allow)	Adds 'not selected' option.
CustomEnumParameter.Builder	singleValue(String value)	Overrides values set by CustomEnumParameter.Setter.values(Iterable) or CustomEnumParameter.Setter.values(String...) methods.
CustomEnumParameter.Builder	tooltip(String value)	Sets a tooltip for an item.
CustomEnumParameter.Builder	values(Iterable<String> values)	Overrides values set by CustomEnumParameter.Setter.values(String...) or CustomEnumParameter.Setter.singleValue(String) methods.
CustomEnumParameter.Builder	values(String... values)	Overrides values set by CustomEnumParameter.Setter.values(Iterable) or CustomEnumParameter.Setter.singleValue(String) methods.

Methods inherited from interface com.polarion.alm.shared.api.model.rp.parameter.CustomEnumParameter.Setter

clear

Methods inherited from interface com.polarion.alm.shared.api.model.rp.parameter.RichPageParameter.Builder

build, dependencySource, dependencyTarget

Method Details

addEnumItem

@NotNull
CustomEnumParameter.Builder addEnumItem(@NotNull
 String value,
 @Nullable
 String label)

Description copied from interface: CustomEnumParameter.Setter

Adds an enumeration item.

Specified by:

addEnumItem in interface CustomEnumParameter.Setter

Parameters:

value - id of the option, selected value will be returned in CustomEnumParameter.values()

label - that will be shown to user, if label is null, value will be used as label

Returns:

the same instance to allow method chaining.

tooltip

@NotNull
CustomEnumParameter.Builder tooltip(@NotNull
 String value)

Description copied from interface: CustomEnumParameter.Setter

Sets a tooltip for an item.

Specified by:

tooltip in interface CustomEnumParameter.Setter

Parameters:

value - The tooltip text to use for the item.

Returns:

the same instance to allow method chaining.

Since:

3.25.6

allowNoValue

@NotNull
CustomEnumParameter.Builder allowNoValue(boolean allow)

Description copied from interface: CustomEnumParameter.Setter

Adds 'not selected' option.

Specified by:

allowNoValue in interface CustomEnumParameter.Setter

allowMultipleValues

@NotNull
CustomEnumParameter.Builder allowMultipleValues(boolean value)

Specified by:

allowMultipleValues in interface CustomEnumParameter.Setter

values

@NotNull
CustomEnumParameter.Builder values(@Nullable
 Iterable<String> values)

Description copied from interface: CustomEnumParameter.Setter

Overrides values set by CustomEnumParameter.Setter.values(String...) or CustomEnumParameter.Setter.singleValue(String) methods.

Specified by:

values in interface CustomEnumParameter.Setter

Returns:

the same instance to allow method chaining.

values

@NotNull
CustomEnumParameter.Builder values(@Nullable
 String... values)

Description copied from interface: CustomEnumParameter.Setter

Overrides values set by CustomEnumParameter.Setter.values(Iterable) or CustomEnumParameter.Setter.singleValue(String) methods.

Specified by:

values in interface CustomEnumParameter.Setter

Returns:

the same instance to allow method chaining.

singleValue

@NotNull
CustomEnumParameter.Builder singleValue(@Nullable
 String value)

Description copied from interface: CustomEnumParameter.Setter

Overrides values set by CustomEnumParameter.Setter.values(Iterable) or CustomEnumParameter.Setter.values(String...) methods.

Specified by:

singleValue in interface CustomEnumParameter.Setter

Returns:

the same instance to allow method chaining.