siren

Class Field.Builder<T>

java.lang.Object

siren.Field.Builder<T>

All Implemented Interfaces:

Builder<Field<T>>

Enclosing class:

Field<T>

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

Constructs an instance of Field.Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Field<T>	build() Constructs an instance of T with the current state of the builder.
void	clear() Clears the state of the builder.
Field.Builder<T>	name(java.lang.String name) Adds the name provided to the current state of the builder.
Field.Builder<T>	title(java.lang.String title) Adds the title provided to the current state of the builder.
Field.Builder<T>	type(FieldType type) Adds the type provided to the current state of the builder.
Field.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

name

public Field.Builder<T> name(java.lang.String name)

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

Parameters:

name - A name describing the control. Field names MUST be unique within the set of fields for an action. The behaviour of clients when parsing a Siren document that violates this constraint is undefined.

Returns:

The builder this method is called on.

title

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

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

Parameters:

title - Textual annotation of a field. Clients may use this as a label.

Returns:

The builder this method is called on.

type

public Field.Builder<T> type(FieldType type)

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

Parameters:

type - The input type of the field. This is a subset of the input types specified by HTML5.

Returns:

The builder this method is called on.

value

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

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

Parameters:

value - The value assigned to the field.

Returns:

The builder this method is called on.

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<Field<T>>

build

public Field<T> build()

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

Specified by:

build in interface Builder<Field<T>>

Returns:

Instance of T with the current state of the builder.