Package org.springframework.hateoas.server.mvc

Interface UriComponentsContributor

public interface UriComponentsContributor

SPI callback to enhance a UriComponentsBuilder when referring to a method through a dummy method invocation. Will usually be implemented in implementations of HandlerMethodArgumentResolver as they represent exactly the same functionality inverted.

Author:

Oliver Gierke

See Also:

• MethodLinkBuilderFactory.linkTo(Object)

Method Summary

Modifier and Type	Method	Description
void	enhance(UriComponentsBuilder builder, MethodParameter parameter, Object value)	Enhance the given UriComponentsBuilder with the given value.
boolean	supportsParameter(MethodParameter parameter)	Returns whether the UriComponentsBuilder supports the given MethodParameter.

Method Details

supportsParameter

boolean supportsParameter(MethodParameter parameter)

Returns whether the UriComponentsBuilder supports the given MethodParameter.

Parameters:

parameter - will never be null.

Returns:

enhance

void enhance(UriComponentsBuilder builder,
 @Nullable
 MethodParameter parameter,
 @Nullable
 Object value)

Enhance the given UriComponentsBuilder with the given value.

Parameters:

builder - will never be null.

parameter - can be null.

value - can be null.