com.opencloud.rem.common.form

Class FieldValueProviderBuilder

java.lang.Object

com.opencloud.rem.common.form.FieldValueProviderBuilder

public class FieldValueProviderBuilder
extends Object

Used to construct a new FieldValueProvider.

Usage example:

   

   FieldValueProvider fieldValueProvider = FieldValueProviderBuilder.newFieldValueProvider()
       .addValue("Foo", "foo")
       .addValue("Bar", "bar")
       .restrictive()
       .build();

Method Summary

Modifier and Type	Method and Description
FieldValueProviderBuilder	addContext(String key, String value) Adds a context entry to the FieldValueProvider, to be used when calculating the field's values at display time.
FieldValueProviderBuilder	addNamedValue(String name, String value) Adds a single value to the FieldValueProvider using the specified name as its name.
FieldValueProviderBuilder	addNamedValues(Map<String,String> namedValues) Adds all the given named values to the FieldValueProvider.
FieldValueProviderBuilder	addValue(String value) Adds a single value to the FieldValueProvider using the value itself as the name.
FieldValueProviderBuilder	addValues(Collection<String> values) Adds all the given values to the FieldValueProvider using the values themselves as the names.
FieldValueProvider	build() Builds a new FieldValueProvider using the values provided by this FieldValueProvider.
FieldValueProviderBuilder	dynamic() Marks this FieldValueProvider as dynamic, meaning that the field's values are expected to be calculated at display time.
FieldValueProviderBuilder	dynamic(boolean dynamic) Sets this FieldValueProvider's dynamic flag.
static FieldValueProviderBuilder	newFieldValueProvider() Starts building a new FieldValueProvider.
FieldValueProviderBuilder	restrictive() Marks this FieldValueProvider as restrictive, meaning that the corresponding field should be restricted to the provided values.
FieldValueProviderBuilder	restrictive(boolean restrictive) Sets this FieldValueProvider's restrictive flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newFieldValueProvider

public static FieldValueProviderBuilder newFieldValueProvider()

Starts building a new FieldValueProvider.

Returns:

a new FieldValueProviderBuilder

addValue

public FieldValueProviderBuilder addValue(String value)

Adds a single value to the FieldValueProvider using the value itself as the name.

Parameters:

value - the value to add

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

addValues

public FieldValueProviderBuilder addValues(Collection<String> values)

Adds all the given values to the FieldValueProvider using the values themselves as the names.

Parameters:

values - a Collection of values to add

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

addNamedValue

public FieldValueProviderBuilder addNamedValue(String name,
                                               String value)

Adds a single value to the FieldValueProvider using the specified name as its name.

Parameters:

name - the name of the value

value - the value to add

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

addNamedValues

public FieldValueProviderBuilder addNamedValues(Map<String,String> namedValues)

Adds all the given named values to the FieldValueProvider.

Parameters:

namedValues - a Map of named values to add

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

restrictive

public FieldValueProviderBuilder restrictive()

Marks this FieldValueProvider as restrictive, meaning that the corresponding field should be restricted to the provided values.

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

restrictive

public FieldValueProviderBuilder restrictive(boolean restrictive)

Sets this FieldValueProvider's restrictive flag.

Parameters:

restrictive - true if the field should be restricted to the provided values (default is false)

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

dynamic

public FieldValueProviderBuilder dynamic()

Marks this FieldValueProvider as dynamic, meaning that the field's values are expected to be calculated at display time.

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

dynamic

public FieldValueProviderBuilder dynamic(boolean dynamic)

Sets this FieldValueProvider's dynamic flag.

Parameters:

dynamic - true if the field's values are expected to be calculated at display time (default is false)

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

addContext

public FieldValueProviderBuilder addContext(String key,
                                            String value)

Adds a context entry to the FieldValueProvider, to be used when calculating the field's values at display time.

Parameters:

key - the key of the context entry

value - the value of the context entry

Returns:

the FieldValueProviderBuilder being used to construct this FieldValueProvider

build

public FieldValueProvider build()

Builds a new FieldValueProvider using the values provided by this FieldValueProvider.

Returns:

the new FieldValueProvider