org.springframework.hateoas.mediatype

Interface AffordanceModelFactory

public interface AffordanceModelFactory

SPI for media type implementations to create a specific AffordanceModel for a ConfiguredAffordance.

Author:

Greg Turnquist, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
default AffordanceModel	getAffordanceModel(ConfiguredAffordance configured) Return the AffordanceModel for the given ConfiguredAffordance.
default AffordanceModel	getAffordanceModel(String name, Link link, HttpMethod httpMethod, AffordanceModel.InputPayloadMetadata inputType, List<QueryParameter> queryMethodParameters, AffordanceModel.PayloadMetadata outputType) Deprecated. since 1.3 in favor of getAffordanceModel(ConfiguredAffordance). Will be removed in 1.4.
MediaType	getMediaType() Declare the MediaType this factory supports.

Method Detail

getMediaType

MediaType getMediaType()

Declare the MediaType this factory supports.

Returns:

getAffordanceModel

@Deprecated
default AffordanceModel getAffordanceModel(String name,
                                                       Link link,
                                                       HttpMethod httpMethod,
                                                       AffordanceModel.InputPayloadMetadata inputType,
                                                       List<QueryParameter> queryMethodParameters,
                                                       AffordanceModel.PayloadMetadata outputType)

Deprecated. since 1.3 in favor of getAffordanceModel(ConfiguredAffordance). Will be removed in 1.4.

Look up the AffordanceModel for this factory.

Parameters:

name -

link -

httpMethod -

inputType -

queryMethodParameters -

outputType -

Returns:

getAffordanceModel

default AffordanceModel getAffordanceModel(ConfiguredAffordance configured)

Return the AffordanceModel for the given ConfiguredAffordance.

Parameters:

configured - will never be null.

Returns:

must not be null.

Since:

1.3