org.springframework.hateoas.mediatype

Class Affordances

java.lang.Object

org.springframework.hateoas.mediatype.Affordances

All Implemented Interfaces:

AffordanceOperations

public class Affordances
extends Object
implements AffordanceOperations

Primary API to construct Affordance instances.

Author:

Oliver Drotbohm

See Also:

afford(HttpMethod)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Affordances.AffordanceBuilder Deprecated. since 1.3, refer to ConfiguredAffordance instead. Will be made private in 1.4.

Method Summary

Modifier and Type	Method and Description
Affordances.AffordanceBuilder	afford(HttpMethod httpMethod) Creates a new Affordances.AffordanceBuilder for the given HTTP method for further customization.
static Affordances	of(Link link)
Stream<Affordance>	stream() Returns all Affordances created.
Link	toLink() Returns a Link equipped with the Affordance currently under construction.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static Affordances of(Link link)

stream

public Stream<Affordance> stream()

Returns all Affordances created.

Returns:

will never be null.

afford

public Affordances.AffordanceBuilder afford(HttpMethod httpMethod)

Creates a new Affordances.AffordanceBuilder for the given HTTP method for further customization. See the wither-methods for details.

Parameters:

httpMethod - must not be null.

Returns:

will never be null.

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.