org.springframework.hateoas.mediatype

Class Affordances.AffordanceBuilder

java.lang.Object

org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder

All Implemented Interfaces:

AffordanceOperations

Enclosing class:

Affordances

public static class Affordances.AffordanceBuilder
extends Object
implements AffordanceOperations

Builder API for Affordance instances.

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method and Description
Affordances.AffordanceBuilder	addParameters(QueryParameter... parameters) Adds the given QueryParameters to the Affordance to build.
Affordances.AffordanceBuilder	andAfford(HttpMethod method) Concludes the creation of the current Affordance to build and starts a new one.
Affordances	build() Builds the Affordance currently under construction and returns in alongside the ones already contained in the Link the buildup started from.
Link	toLink() Returns a Link equipped with the Affordance currently under construction.
Affordances.AffordanceBuilder	withInput(AffordanceModel.PayloadMetadata metadata) Registers the given AffordanceModel.PayloadMetadata as input model.
Affordances.AffordanceBuilder	withInput(Class<?> type) Registers the given type as input model for the affordance.
Affordances.AffordanceBuilder	withInput(ResolvableType type) Registers the given ResolvableType as input model for the affordance.
Affordances.AffordanceBuilder	withInputAndOutput(AffordanceModel.PayloadMetadata metadata) Registers the given AffordanceModel.PayloadMetadata as input and output model.
Affordances.AffordanceBuilder	withInputAndOutput(Class<?> type) Registers the given type as input and output model for the affordance.
Affordances.AffordanceBuilder	withInputAndOutput(ResolvableType type) Registers the given ResolvableType as input and output model for the affordance.
Affordances.AffordanceBuilder	withName(String name) Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the name.
Affordances.AffordanceBuilder	withOutput(AffordanceModel.PayloadMetadata metadata) Registers the given AffordanceModel.PayloadMetadata as output model.
Affordances.AffordanceBuilder	withOutput(Class<?> type) Registers the given type as the output model.
Affordances.AffordanceBuilder	withOutput(ResolvableType type) Registers the given ResolvableType as the output model.
Affordances.AffordanceBuilder	withParameters(List<QueryParameter> parameters) Replaces the current QueryParameter list with the given ones.
Affordances.AffordanceBuilder	withParameters(QueryParameter... parameters) Replaces the current QueryParameter list with the given ones.
Affordances.AffordanceBuilder	withTarget(Link target) Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the target.

Methods inherited from class java.lang.Object

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

Method Detail

withInputAndOutput

public Affordances.AffordanceBuilder withInputAndOutput(Class<?> type)

Registers the given type as input and output model for the affordance.

Parameters:

type - must not be null.

Returns:

will never be null.

withInputAndOutput

public Affordances.AffordanceBuilder withInputAndOutput(ResolvableType type)

Registers the given ResolvableType as input and output model for the affordance.

Parameters:

type - must not be null.

Returns:

will never be null.

withInputAndOutput

public Affordances.AffordanceBuilder withInputAndOutput(AffordanceModel.PayloadMetadata metadata)

Registers the given AffordanceModel.PayloadMetadata as input and output model.

Parameters:

metadata - must not be null.

Returns:

will never be null.

withInput

public Affordances.AffordanceBuilder withInput(Class<?> type)

Registers the given type as input model for the affordance.

Parameters:

type - must not be null.

Returns:

will never be null.

withInput

public Affordances.AffordanceBuilder withInput(ResolvableType type)

Registers the given ResolvableType as input model for the affordance.

Parameters:

type - must not be null.

Returns:

will never be null.

withInput

public Affordances.AffordanceBuilder withInput(AffordanceModel.PayloadMetadata metadata)

Registers the given AffordanceModel.PayloadMetadata as input model.

Parameters:

metadata - must not be null.

Returns:

will never be null.

withOutput

public Affordances.AffordanceBuilder withOutput(Class<?> type)

Registers the given type as the output model.

Parameters:

type - must not be null.

Returns:

will never be null.

withOutput

public Affordances.AffordanceBuilder withOutput(ResolvableType type)

Registers the given ResolvableType as the output model.

Parameters:

type - must not be null.

Returns:

will never be null.

withOutput

public Affordances.AffordanceBuilder withOutput(AffordanceModel.PayloadMetadata metadata)

Registers the given AffordanceModel.PayloadMetadata as output model.

Parameters:

metadata - must not be null.

Returns:

will never be null.

withParameters

public Affordances.AffordanceBuilder withParameters(QueryParameter... parameters)

Replaces the current QueryParameter list with the given ones.

Parameters:

parameters - must not be null.

Returns:

will never be null.

withParameters

public Affordances.AffordanceBuilder withParameters(List<QueryParameter> parameters)

Replaces the current QueryParameter list with the given ones.

Parameters:

parameters - must not be null.

Returns:

will never be null.

addParameters

public Affordances.AffordanceBuilder addParameters(QueryParameter... parameters)

Adds the given QueryParameters to the Affordance to build.

Parameters:

parameters - must not be null.

Returns:

will never be null.

andAfford

public Affordances.AffordanceBuilder andAfford(HttpMethod method)

Concludes the creation of the current Affordance to build and starts a new one.

Parameters:

method - must not be null.

Returns:

See Also:

build(), toLink()

toLink

public Link toLink()

Description copied from interface: AffordanceOperations

Returns a Link equipped with the Affordance currently under construction.

Specified by:

toLink in interface AffordanceOperations

Returns:

will never be null.

build

public Affordances build()

Builds the Affordance currently under construction and returns in alongside the ones already contained in the Link the buildup started from.

Returns:

will never be null.

withTarget

public Affordances.AffordanceBuilder withTarget(Link target)

Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the target.

Parameters:

target -

Returns:

withName

public Affordances.AffordanceBuilder withName(@Nullable
                                              String name)

Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the name.

Parameters:

name -

Returns: