Package org.springframework.hateoas

Class AffordanceModel

java.lang.Object

org.springframework.hateoas.AffordanceModel

public abstract class AffordanceModel
extends Object

Collection of attributes needed to render any form of hypermedia.

Author:

Greg Turnquist, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AffordanceModel.InputPayloadMetadata	Payload metadata for incoming requests.
static interface	AffordanceModel.Named	A named component.
static interface	AffordanceModel.PayloadMetadata	Metadata about payloads.
static interface	AffordanceModel.PropertyMetadata	Metadata about the property model of a representation.
static interface	AffordanceModel.PropertyMetadataConfigured<T>	SPI for a type that can get AffordanceModel.PropertyMetadata applied.

Constructor Summary

Constructors

Constructor	Description
AffordanceModel(String name, Link link, org.springframework.http.HttpMethod httpMethod, AffordanceModel.InputPayloadMetadata input, List<QueryParameter> queryMethodParameters, AffordanceModel.PayloadMetadata output)

Method Summary

Modifier and Type	Method	Description
<T> List<T>	createProperties(BiFunction<AffordanceModel.InputPayloadMetadata,AffordanceModel.PropertyMetadata,T> creator)	Creates a List of properties based on the given creator.
boolean	equals(@Nullable Object o)
org.springframework.http.HttpMethod	getHttpMethod()
AffordanceModel.InputPayloadMetadata	getInput()
Link	getLink()
String	getName()
AffordanceModel.PayloadMetadata	getOutput()
List<QueryParameter>	getQueryMethodParameters()
String	getURI()	Expand the Link into an href with no parameters.
int	hashCode()
boolean	hasHttpMethod(org.springframework.http.HttpMethod method)	Returns whether the Affordance has the given HttpMethod.
boolean	pointsToTargetOf(Link link)	Returns whether the Affordance points to the target of the given Link.

Methods inherited from class java.lang.Object

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

Constructor Details

AffordanceModel

public AffordanceModel(String name,
 Link link,
 org.springframework.http.HttpMethod httpMethod,
 AffordanceModel.InputPayloadMetadata input,
 List<QueryParameter> queryMethodParameters,
 AffordanceModel.PayloadMetadata output)

Method Details

getURI

public String getURI()

Expand the Link into an href with no parameters.

Returns:

hasHttpMethod

public boolean hasHttpMethod(org.springframework.http.HttpMethod method)

Returns whether the Affordance has the given HttpMethod.

Parameters:

method - must not be null.

Returns:

pointsToTargetOf

public boolean pointsToTargetOf(Link link)

Returns whether the Affordance points to the target of the given Link.

Parameters:

link - must not be null.

Returns:

getName

public String getName()

getLink

public Link getLink()

getHttpMethod

public org.springframework.http.HttpMethod getHttpMethod()

getInput

public AffordanceModel.InputPayloadMetadata getInput()

getQueryMethodParameters

public List<QueryParameter> getQueryMethodParameters()

getOutput

public AffordanceModel.PayloadMetadata getOutput()

createProperties

public <T> List<T> createProperties(BiFunction<AffordanceModel.InputPayloadMetadata,AffordanceModel.PropertyMetadata,T> creator)

Creates a List of properties based on the given creator.

Type Parameters:

T - the property type

Parameters:

creator - a creator function that turns an AffordanceModel.InputPayloadMetadata and AffordanceModel.PropertyMetadata into a property instance.

Returns:

will never be null.

Since:

1.3

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object