org.springframework.hateoas.server.core

Class LinkBuilderSupport<T extends LinkBuilder>

java.lang.Object

org.springframework.hateoas.server.core.LinkBuilderSupport<T>

All Implemented Interfaces:

LinkBuilder

Direct Known Subclasses:

TemplateVariableAwareLinkBuilderSupport

public abstract class LinkBuilderSupport<T extends LinkBuilder>
extends Object
implements LinkBuilder

Base class to implement LinkBuilders based on a Spring MVC UriComponentsBuilder.

Author:

Ricardo Gladwell, Oliver Gierke, Kamill Sokol, Kevin Conaway, Greg Turnquist

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinkBuilderSupport(org.springframework.web.util.UriComponentsBuilder builder) Creates a new LinkBuilderSupport using the given UriComponents.
protected	LinkBuilderSupport(org.springframework.web.util.UriComponentsBuilder builder, List<Affordance> affordances)
protected	LinkBuilderSupport(org.springframework.web.util.UriComponents components, List<Affordance> affordances)

Method Summary

Modifier and Type	Method and Description
T	addAffordances(Collection<Affordance> affordances)
protected abstract T	createNewInstance(org.springframework.web.util.UriComponentsBuilder builder, List<Affordance> affordances) Creates a new instance of the sub-class.
protected abstract T	getThis() Returns the current concrete instance.
T	slash(Object object) Adds the given object's String representation as sub-resource to the current URI.
protected T	slash(org.springframework.web.util.UriComponents components, boolean encoded)
String	toString()
URI	toUri() Creates a URI of the link built by the current builder instance.
protected <S> S	withFreshBuilder(Function<org.springframework.web.util.UriComponentsBuilder,S> function) Executes the given Function using a freshly cloned UriComponentsBuilder.
Link	withRel(LinkRelation rel) Creates the Link built by the current builder instance with the given LinkRelation.
Link	withSelfRel() Creates the Link built by the current builder instance with the default self link relation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.server.LinkBuilder

withRel

Constructor Detail

LinkBuilderSupport

protected LinkBuilderSupport(org.springframework.web.util.UriComponentsBuilder builder)

Creates a new LinkBuilderSupport using the given UriComponents.

Parameters:

builder - must not be null.

LinkBuilderSupport

protected LinkBuilderSupport(org.springframework.web.util.UriComponentsBuilder builder,
                             List<Affordance> affordances)

LinkBuilderSupport

protected LinkBuilderSupport(org.springframework.web.util.UriComponents components,
                             List<Affordance> affordances)

Method Detail

slash

public T slash(Object object)

Description copied from interface: LinkBuilder

Adds the given object's String representation as sub-resource to the current URI.

Specified by:

slash in interface LinkBuilder

Returns:

slash

protected T slash(org.springframework.web.util.UriComponents components,
                  boolean encoded)

toUri

public URI toUri()

Description copied from interface: LinkBuilder

Creates a URI of the link built by the current builder instance.

Specified by:

toUri in interface LinkBuilder

Returns:

addAffordances

public T addAffordances(Collection<Affordance> affordances)

withRel

public Link withRel(LinkRelation rel)

Description copied from interface: LinkBuilder

Creates the Link built by the current builder instance with the given LinkRelation.

Specified by:

withRel in interface LinkBuilder

Parameters:

rel - must not be null or empty.

Returns:

withSelfRel

public Link withSelfRel()

Description copied from interface: LinkBuilder

Creates the Link built by the current builder instance with the default self link relation.

Specified by:

withSelfRel in interface LinkBuilder

Returns:

See Also:

IanaLinkRelations.SELF

toString

public String toString()

Overrides:

toString in class Object

withFreshBuilder

protected <S> S withFreshBuilder(Function<org.springframework.web.util.UriComponentsBuilder,S> function)

Executes the given Function using a freshly cloned UriComponentsBuilder.

Parameters:

function - must not be null.

Returns:

getThis

protected abstract T getThis()

Returns the current concrete instance.

Returns:

createNewInstance

protected abstract T createNewInstance(org.springframework.web.util.UriComponentsBuilder builder,
                                       List<Affordance> affordances)

Creates a new instance of the sub-class.

Parameters:

builder - will never be null.

Returns: