siren

Class FieldValue.Builder<T>

java.lang.Object

siren.FieldValue.Builder<T>

All Implemented Interfaces:

Builder<FieldValue<T>>

Enclosing class:

FieldValue<T>

public static class FieldValue.Builder<T>
extends java.lang.Object
implements Builder<FieldValue<T>>

Constructs an instance of FieldValue.Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FieldValue<T>	build() Constructs an instance of T with the current state of the builder.
void	clear() Clears the state of the builder.
FieldValue.Builder<T>	selected(java.lang.Boolean selected) Adds the provided flag indicating whether to be selected to the current state of the builder.
FieldValue.Builder<T>	title(java.lang.String title) Adds the title provided to the current state of the builder.
FieldValue.Builder<T>	value(T value) Adds the value provided to the current state of the builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

value

public FieldValue.Builder<T> value(T value)

Adds the value provided to the current state of the builder.

Parameters:

value - Possible value for the field.

Returns:

The builder this method is called on.

title

public FieldValue.Builder<T> title(java.lang.String title)

Adds the title provided to the current state of the builder.

Parameters:

title - Textual description of a field value.

Returns:

The builder this method is called on.

selected

public FieldValue.Builder<T> selected(java.lang.Boolean selected)

Adds the provided flag indicating whether to be selected to the current state of the builder.

Parameters:

selected - Indicates whether this field value should be considered preselected by the client.

Returns:

The builder this method is called on.

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<FieldValue<T>>

build

public FieldValue<T> build()

Constructs an instance of T with the current state of the builder.

Specified by:

build in interface Builder<FieldValue<T>>

Returns:

Instance of T with the current state of the builder.