org.springframework.hateoas

Interface AffordanceModel.InputPayloadMetadata

All Superinterfaces:

AffordanceModel.PayloadMetadata

Enclosing class:

AffordanceModel

public static interface AffordanceModel.InputPayloadMetadata
extends AffordanceModel.PayloadMetadata

Payload metadata for incoming requests.

Author:

Oliver Drotbohm

Field Summary

Fields

Modifier and Type	Field and Description
static AffordanceModel.InputPayloadMetadata	NONE

Method Summary

Modifier and Type	Method and Description
default <T extends AffordanceModel.PropertyMetadataConfigured<T> & AffordanceModel.Named> T	applyTo(T target) Deprecated. since 1.3, prefer setting up the model types via #createProperties(Function)
<T extends AffordanceModel.Named> T	customize(T target, Function<AffordanceModel.PropertyMetadata,T> customizer)
static AffordanceModel.InputPayloadMetadata	from(AffordanceModel.PayloadMetadata metadata)
List<String>	getI18nCodes() Returns the I18n codes to be used to resolve a name for the payload metadata.
List<MediaType>	getMediaTypes() Returns the MediaType that the payload requires.
default MediaType	getPrimaryMediaType() Returns the primary MediaType expected for the input.
AffordanceModel.InputPayloadMetadata	withMediaTypes(List<MediaType> mediaType) Creates a new AffordanceModel.InputPayloadMetadata with the given MediaType assigned.

Methods inherited from interface org.springframework.hateoas.AffordanceModel.PayloadMetadata

getPropertyMetadata, getType, stream

Field Detail

NONE

static final AffordanceModel.InputPayloadMetadata NONE

Method Detail

from

static AffordanceModel.InputPayloadMetadata from(AffordanceModel.PayloadMetadata metadata)

applyTo

@Deprecated
default <T extends AffordanceModel.PropertyMetadataConfigured<T> & AffordanceModel.Named> T applyTo(T target)

Deprecated. since 1.3, prefer setting up the model types via #createProperties(Function)

Applies the AffordanceModel.InputPayloadMetadata to the given target.

Type Parameters:

T -

Parameters:

target -

Returns:

customize

<T extends AffordanceModel.Named> T customize(T target,
                                              Function<AffordanceModel.PropertyMetadata,T> customizer)

getI18nCodes

List<String> getI18nCodes()

Returns the I18n codes to be used to resolve a name for the payload metadata.

Returns:

withMediaTypes

AffordanceModel.InputPayloadMetadata withMediaTypes(List<MediaType> mediaType)

Creates a new AffordanceModel.InputPayloadMetadata with the given MediaType assigned.

Parameters:

mediaType - can be null.

Returns:

will never be null.

Since:

1.3

getMediaTypes

List<MediaType> getMediaTypes()

Returns the MediaType that the payload requires.

Returns:

will never be null.

Since:

1.3

getPrimaryMediaType

@Nullable
default MediaType getPrimaryMediaType()

Returns the primary MediaType expected for the input. That is, from getMediaTypes() the first one, if available.

Returns:

can be null.