org.springframework.hateoas.mediatype.hal.forms

Class HalFormsConfiguration

java.lang.Object

org.springframework.hateoas.mediatype.hal.forms.HalFormsConfiguration

public class HalFormsConfiguration
extends Object

HAL-FORMS specific configuration extension of HalConfiguration.

Author:

Greg Turnquist, Oliver Drotbohm

Constructor Summary

Constructors

Constructor and Description
HalFormsConfiguration() Creates a new HalFormsConfiguration backed by a default HalConfiguration.
HalFormsConfiguration(HalConfiguration halConfiguration) Creates a new HalFormsConfiguration for the given HalConfiguration.

Method Summary

Modifier and Type	Method and Description
HalFormsConfiguration	customize(com.fasterxml.jackson.databind.ObjectMapper mapper) Customizes the given ObjectMapper with the registered callback.
HalConfiguration	getHalConfiguration() Returns the underlying HalConfiguration.
HalFormsConfiguration	withMediaType(MediaType mediaType) Registers additional media types that are supposed to be aliases to MediaTypes.HAL_FORMS_JSON.
HalFormsConfiguration	withObjectMapperCustomizer(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer) Register the given Consumer to apply additional customizations on the ObjectMapper used to render HAL documents.
<T> HalFormsConfiguration	withOptions(Class<T> type, String property, Function<AffordanceModel.PropertyMetadata,HalFormsOptions> creator) Returns a new HalFormsConfiguration with the given
HalFormsConfiguration	withPattern(Class<?> type, String pattern) Registers a regular expression pattern to be used for form descriptions of the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

HalFormsConfiguration

public HalFormsConfiguration()

Creates a new HalFormsConfiguration backed by a default HalConfiguration.

HalFormsConfiguration

public HalFormsConfiguration(HalConfiguration halConfiguration)

Creates a new HalFormsConfiguration for the given HalConfiguration.

Parameters:

halConfiguration - must not be null.

Method Detail

withPattern

public HalFormsConfiguration withPattern(Class<?> type,
                                         String pattern)

Registers a regular expression pattern to be used for form descriptions of the given type.

Parameters:

type - must not be null.

pattern - must not be null or empty.

Returns:

will never be null.

withObjectMapperCustomizer

public HalFormsConfiguration withObjectMapperCustomizer(Consumer<com.fasterxml.jackson.databind.ObjectMapper> objectMapperCustomizer)

Register the given Consumer to apply additional customizations on the ObjectMapper used to render HAL documents.

Parameters:

objectMapperCustomizer - must not be null.

Returns:

will never be null.

withMediaType

public HalFormsConfiguration withMediaType(MediaType mediaType)

Registers additional media types that are supposed to be aliases to MediaTypes.HAL_FORMS_JSON. Registered MediaTypes will be preferred over the default one, i.e. they'll be listed first in client's accept headers etc.

Parameters:

mediaType - must not be null.

Returns:

will never be null.

Since:

1.4

customize

public HalFormsConfiguration customize(com.fasterxml.jackson.databind.ObjectMapper mapper)

Customizes the given ObjectMapper with the registered callback.

Parameters:

mapper - must not be null.

Returns:

See Also:

withObjectMapperCustomizer(Consumer)

withOptions

public <T> HalFormsConfiguration withOptions(Class<T> type,
                                             String property,
                                             Function<AffordanceModel.PropertyMetadata,HalFormsOptions> creator)

Returns a new HalFormsConfiguration with the given

Type Parameters:

T -

Parameters:

type - the

property -

creator -

Returns:

getHalConfiguration

public HalConfiguration getHalConfiguration()

Returns the underlying HalConfiguration.

Returns:

will never be null.