siren

Class Action.Builder

java.lang.Object

siren.Action.Builder

All Implemented Interfaces:

Builder<Action>

Enclosing class:

Action

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

Constructs an instance of Action.Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Action	build() Constructs an instance of Action with the current state of the builder.
void	clear() Clears the state of the builder.
Action.Builder	field(Field field) Adds the field provided to the current state of the builder.
Action.Builder	fields(Field... fields) Adds the fields provided to the current state of the builder.
Action.Builder	href(java.net.URI href) Adds the href provided to the current state of the builder.
Action.Builder	klass(java.lang.String klass) Adds the class provided to the current state of the builder.
Action.Builder	klasses(java.lang.String... klasses) Adds the classes provided to the current state of the builder.
Action.Builder	method(HttpMethod method) Adds the method provided to the current state of the builder.
Action.Builder	name(java.lang.String name) Adds the name provided to the current state of the builder.
Action.Builder	title(java.lang.String title) Adds the title provided to the current state of the builder.
Action.Builder	type(java.lang.String type) Adds the type 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 Action.Builder name(java.lang.String name)

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

Parameters:

name - A string that identifies the action to be performed.

Returns:

The builder this method is called on.

title

public Action.Builder title(java.lang.String title)

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

Parameters:

title - Descriptive text about the action.

Returns:

The builder this method is called on.

method

public Action.Builder method(HttpMethod method)

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

Parameters:

method - An enumerated attribute mapping to a protocol method.

Returns:

The builder this method is called on.

href

public Action.Builder href(java.net.URI href)

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

Parameters:

href - The URI of the action.

Returns:

The builder this method is called on.

type

public Action.Builder type(java.lang.String type)

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

Parameters:

type - The encoding type for the request.

Returns:

The builder this method is called on.

field

public Action.Builder field(Field field)

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

Parameters:

field - Represent a control inside of the action.

Returns:

The builder this method is called on.

fields

public Action.Builder fields(Field... fields)

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

Parameters:

fields - Represent controls inside of the action.

Returns:

The builder this method is called on.

klass

public Action.Builder klass(java.lang.String klass)

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

Parameters:

klass - Describes the nature of an action based on the current representation.

Returns:

The builder this method is called on.

klasses

public Action.Builder klasses(java.lang.String... klasses)

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

Parameters:

klasses - Descriptions of the nature of an action based on the current representation.

Returns:

The builder this method is called on.

clear

public void clear()

Clears the state of the builder.

Specified by:

clear in interface Builder<Action>

build

public Action build()

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

Specified by:

build in interface Builder<Action>

Returns:

Instance of Action with the current state of the builder.