org.springframework.hateoas.mediatype

Class Affordances.AffordanceBuilder

java.lang.Object

org.springframework.hateoas.mediatype.Affordances.AffordanceBuilder

All Implemented Interfaces:

AffordanceOperations, ConfigurableAffordance, ConfiguredAffordance

Enclosing class:

Affordances

Deprecated.

since 1.3, refer to ConfiguredAffordance instead. Will be made private in 1.4.

@Deprecated
public static class Affordances.AffordanceBuilder
extends Object
implements ConfigurableAffordance, ConfiguredAffordance

Builder API for Affordance instances.

Author:

Oliver Drotbohm

See Also:

ConfigurableAffordance, ConfiguredAffordance

Method Summary

Modifier and Type	Method and Description
Affordances.AffordanceBuilder	addParameters(QueryParameter... parameters) Deprecated. Adds the given QueryParameters to the Affordance to build.
Affordances.AffordanceBuilder	andAfford(HttpMethod method) Deprecated. Concludes the creation of the current Affordance to build and starts a new one.
Affordances	build() Deprecated. Builds the Affordance currently under construction and returns in alongside the ones already contained in the Link the buildup started from.
AffordanceModel.InputPayloadMetadata	getInputMetadata() Deprecated. Metadata about the input payload.
HttpMethod	getMethod() Deprecated. The HttpMethod of the affordance.
String	getNameOrDefault() Deprecated. Returns the explicitly configured name of the Affordance or calculates a default based on the HttpMethod and type backing it.
AffordanceModel.PayloadMetadata	getOutputMetadata() Deprecated. Metadata about the output payload.
List<QueryParameter>	getQueryParameters() Deprecated. The parameters of the affordance.
Link	getTarget() Deprecated. Returns the affordance's target.
Link	toLink() Deprecated. Returns a Link equipped with the Affordance currently under construction.
Affordances.AffordanceBuilder	withInput(AffordanceModel.PayloadMetadata metadata) Deprecated. Registers the given AffordanceModel.PayloadMetadata as input model.
Affordances.AffordanceBuilder	withInput(Class<?> type) Deprecated. Registers the given type as input model for the affordance.
Affordances.AffordanceBuilder	withInput(ResolvableType type) Deprecated. Registers the given ResolvableType as input model for the affordance.
Affordances.AffordanceBuilder	withInputAndOutput(AffordanceModel.PayloadMetadata metadata) Deprecated. Registers the given AffordanceModel.PayloadMetadata as input and output model.
Affordances.AffordanceBuilder	withInputAndOutput(Class<?> type) Deprecated. Registers the given type as input and output model for the affordance.
Affordances.AffordanceBuilder	withInputAndOutput(ResolvableType type) Deprecated. Registers the given ResolvableType as input and output model for the affordance.
ConfigurableAffordance	withInputMediaType(MediaType inputMediaType) Deprecated. Registers the input to expect to be of the given MediaType.
ConfigurableAffordance	withInputMediaTypes(List<MediaType> inputMediaTypes) Deprecated. Registers the given MediaTypes as input payload media types.
ConfigurableAffordance	withName(String name) Deprecated. Create a new Affordances.AffordanceBuilder by copying all attributes and replacing the name.
Affordances.AffordanceBuilder	withOutput(AffordanceModel.PayloadMetadata metadata) Deprecated. Registers the given AffordanceModel.PayloadMetadata as output model.
Affordances.AffordanceBuilder	withOutput(Class<?> type) Deprecated. Registers the given type as the output model.
Affordances.AffordanceBuilder	withOutput(ResolvableType type) Deprecated. Registers the given ResolvableType as the output model.
Affordances.AffordanceBuilder	withParameters(List<QueryParameter> parameters) Deprecated. Replaces the current QueryParameter list with the given ones.
Affordances.AffordanceBuilder	withParameters(QueryParameter... parameters) Deprecated. Replaces the current QueryParameter list with the given ones.
ConfigurableAffordance	withTarget(Link target) Deprecated. 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)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

withInputAndOutput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withInputAndOutput

public Affordances.AffordanceBuilder withInputAndOutput(ResolvableType type)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

withInputAndOutput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withInputAndOutput

public Affordances.AffordanceBuilder withInputAndOutput(AffordanceModel.PayloadMetadata metadata)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

withInputAndOutput in interface ConfigurableAffordance

Parameters:

metadata - must not be null.

Returns:

will never be null.

withInput

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

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given type as input model for the affordance.

Specified by:

withInput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withInput

public Affordances.AffordanceBuilder withInput(ResolvableType type)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given ResolvableType as input model for the affordance.

Specified by:

withInput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withInput

public Affordances.AffordanceBuilder withInput(AffordanceModel.PayloadMetadata metadata)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given AffordanceModel.PayloadMetadata as input model.

Specified by:

withInput in interface ConfigurableAffordance

Parameters:

metadata - must not be null.

Returns:

will never be null.

withOutput

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

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given type as the output model.

Specified by:

withOutput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withOutput

public Affordances.AffordanceBuilder withOutput(ResolvableType type)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given ResolvableType as the output model.

Specified by:

withOutput in interface ConfigurableAffordance

Parameters:

type - must not be null.

Returns:

will never be null.

withOutput

public Affordances.AffordanceBuilder withOutput(AffordanceModel.PayloadMetadata metadata)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given AffordanceModel.PayloadMetadata as output model.

Specified by:

withOutput in interface ConfigurableAffordance

Parameters:

metadata - must not be null.

Returns:

will never be null.

withInputMediaType

public ConfigurableAffordance withInputMediaType(MediaType inputMediaType)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the input to expect to be of the given MediaType.

Specified by:

withInputMediaType in interface ConfigurableAffordance

Parameters:

inputMediaType - can be null.

Returns:

will never be null.

withInputMediaTypes

public ConfigurableAffordance withInputMediaTypes(List<MediaType> inputMediaTypes)

Deprecated.

Description copied from interface: ConfigurableAffordance

Registers the given MediaTypes as input payload media types.

Specified by:

withInputMediaTypes in interface ConfigurableAffordance

Parameters:

inputMediaTypes - must not be null.

Returns:

will never be null.

withParameters

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

Deprecated.

Description copied from interface: ConfigurableAffordance

Replaces the current QueryParameter list with the given ones.

Specified by:

withParameters in interface ConfigurableAffordance

Parameters:

parameters - must not be null.

Returns:

will never be null.

withParameters

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

Deprecated.

Description copied from interface: ConfigurableAffordance

Replaces the current QueryParameter list with the given ones.

Specified by:

withParameters in interface ConfigurableAffordance

Parameters:

parameters - must not be null.

Returns:

will never be null.

addParameters

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

Deprecated.

Description copied from interface: ConfigurableAffordance

Adds the given QueryParameters to the Affordance to build.

Specified by:

addParameters in interface ConfigurableAffordance

Parameters:

parameters - must not be null.

Returns:

will never be null.

withTarget

public ConfigurableAffordance withTarget(Link target)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

withTarget in interface ConfigurableAffordance

Returns:

withName

public ConfigurableAffordance withName(@Nullable
                                       String name)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

withName in interface ConfigurableAffordance

Parameters:

name - can be null.

Returns:

andAfford

public Affordances.AffordanceBuilder andAfford(HttpMethod method)

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

andAfford in interface ConfigurableAffordance

Parameters:

method - must not be null.

Returns:

See Also:

ConfigurableAffordance.build(), AffordanceOperations.toLink()

build

public Affordances build()

Deprecated.

Description copied from interface: ConfigurableAffordance

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

Specified by:

build in interface ConfigurableAffordance

Returns:

will never be null.

toLink

public Link toLink()

Deprecated.

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.

getNameOrDefault

public String getNameOrDefault()

Deprecated.

Description copied from interface: ConfiguredAffordance

Returns the explicitly configured name of the Affordance or calculates a default based on the HttpMethod and type backing it.

Specified by:

getNameOrDefault in interface ConfiguredAffordance

Returns:

will never be null.

getMethod

public HttpMethod getMethod()

Deprecated.

Description copied from interface: ConfiguredAffordance

The HttpMethod of the affordance.

Specified by:

getMethod in interface ConfiguredAffordance

Returns:

will never be null.

getInputMetadata

public AffordanceModel.InputPayloadMetadata getInputMetadata()

Deprecated.

Description copied from interface: ConfiguredAffordance

Metadata about the input payload.

Specified by:

getInputMetadata in interface ConfiguredAffordance

Returns:

will never be null.

getOutputMetadata

public AffordanceModel.PayloadMetadata getOutputMetadata()

Deprecated.

Description copied from interface: ConfiguredAffordance

Metadata about the output payload.

Specified by:

getOutputMetadata in interface ConfiguredAffordance

Returns:

will never be null.

getTarget

public Link getTarget()

Deprecated.

Description copied from interface: ConfiguredAffordance

Returns the affordance's target.

Specified by:

getTarget in interface ConfiguredAffordance

Returns:

will never be null.

getQueryParameters

public List<QueryParameter> getQueryParameters()

Deprecated.

Description copied from interface: ConfiguredAffordance

The parameters of the affordance.

Specified by:

getQueryParameters in interface ConfiguredAffordance

Returns:

will never be null.