org.springframework.hateoas.mediatype.hal

Class HalConfiguration

java.lang.Object

org.springframework.hateoas.mediatype.hal.HalConfiguration

public class HalConfiguration
extends Object

HAL specific configuration.

Author:

Greg Turnquist, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HalConfiguration.RenderSingleLinks Configuration option how to render single links of a given LinkRelation.

Constructor Summary

Constructors

Constructor and Description
HalConfiguration() Creates a new default HalConfiguration rendering single links as immediate sub-document.

Method Summary

Modifier and Type	Method and Description
HalConfiguration	withRenderSingleLinksFor(LinkRelation relation, HalConfiguration.RenderSingleLinks renderSingleLinks) Configures how to render a single link for a given particular LinkRelation.
HalConfiguration	withRenderSingleLinksFor(String pattern, HalConfiguration.RenderSingleLinks renderSingleLinks) Configures how to render a single link for the given link relation pattern, i.e. this can be either a fixed link relation (like search), take wildcards to e.g. match links of a given curie (like acme:*) or even complete URIs (like https://api.acme.com/foo/**).

Methods inherited from class java.lang.Object

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

Constructor Detail

HalConfiguration

public HalConfiguration()

Creates a new default HalConfiguration rendering single links as immediate sub-document.

Method Detail

withRenderSingleLinksFor

public HalConfiguration withRenderSingleLinksFor(LinkRelation relation,
                                                 HalConfiguration.RenderSingleLinks renderSingleLinks)

Configures how to render a single link for a given particular LinkRelation. This will override what has been configured via #withRenderSingleLinks(RenderSingleLinks) for that particular link relation.

Parameters:

relation - must not be null.

renderSingleLinks - must not be null.

Returns:

withRenderSingleLinksFor

public HalConfiguration withRenderSingleLinksFor(String pattern,
                                                 HalConfiguration.RenderSingleLinks renderSingleLinks)

Configures how to render a single link for the given link relation pattern, i.e. this can be either a fixed link relation (like search), take wildcards to e.g. match links of a given curie (like acme:*) or even complete URIs (like https://api.acme.com/foo/**).

Parameters:

pattern - must not be null.

renderSingleLinks - must not be null.

Returns:

@see PathMatcher