Package de.ingogriebsch.spring.hateoas.siren

Interface SirenActionFieldTypeConverter

public interface SirenActionFieldTypeConverter

SPI to convert a property that is part of an AffordanceModel and the type of the surrounding Siren action into a SirenActionFieldType.

Since:

1.0.0

Author:

Ingo Griebsch

See Also:

SirenActionFieldType, Siren Action Field Type, Siren Action Type

Field Summary

Fields

Modifier and Type	Field	Description
static SirenActionFieldTypeConverter	DEFAULT_INSTANCE	The default instance that can be used if no specific implementation of this interface is necessary.

Method Summary

Modifier and Type	Method	Description
default SirenActionFieldType	convert(@NonNull org.springframework.hateoas.AffordanceModel.PropertyMetadata fieldMetadata, @NonNull org.springframework.http.MediaType actionType)	Deprecated. use execute(PropertyMetadata, MediaType) instead.
default Optional<org.springframework.hateoas.mediatype.html.HtmlInputType>	execute(@NonNull org.springframework.hateoas.AffordanceModel.PropertyMetadata fieldMetadata, @NonNull org.springframework.http.MediaType actionType)	Converts the given property metadata and the type of the respective Siren action into a HtmlInputType, if possible.

Field Detail

DEFAULT_INSTANCE

static final SirenActionFieldTypeConverter DEFAULT_INSTANCE

The default instance that can be used if no specific implementation of this interface is necessary.

Method Detail

convert

@Deprecated
default SirenActionFieldType convert(@NonNull
                                     @NonNull org.springframework.hateoas.AffordanceModel.PropertyMetadata fieldMetadata,
                                     @NonNull
                                     @NonNull org.springframework.http.MediaType actionType)

Deprecated.

use execute(PropertyMetadata, MediaType) instead.

Converts the given property metadata and the type of the respective Siren action into a SirenActionFieldType.

The default implementation always returns the fallback, as specified through the specification.

Parameters:

fieldMetadata - the metadata of the property. Is never null.

actionType - the type of the action. Is never null.

Returns:

the matching SirenActionFieldType.

execute

default Optional<org.springframework.hateoas.mediatype.html.HtmlInputType> execute(@NonNull
                                                                                   @NonNull org.springframework.hateoas.AffordanceModel.PropertyMetadata fieldMetadata,
                                                                                   @NonNull
                                                                                   @NonNull org.springframework.http.MediaType actionType)

Converts the given property metadata and the type of the respective Siren action into a HtmlInputType, if possible.

The default implementation always returns the fallback, as specified through the specification.

Parameters:

fieldMetadata - the metadata of the property. Is never null.

actionType - the type of the action. Is never null.

Returns:

the matching HtmlInputType or an empty Optional.