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:

BasicLinkBuilder, 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(UriComponents builder) Creates a new LinkBuilderSupport using the given UriComponents.
protected	LinkBuilderSupport(UriComponentsBuilder builder, List<Affordance> affordances) Deprecated. since 1.0.3, for removal in 1.1. Use LinkBuilderSupport(UriComponents, List) instead.
protected	LinkBuilderSupport(UriComponents components, List<Affordance> affordances) Creates a new LinkBuilderSupport using the given UriComponents and Affordances.

Method Summary

Modifier and Type	Method and Description
T	addAffordances(Collection<Affordance> affordances)
protected T	createNewInstance(UriComponentsBuilder builder, List<Affordance> affordances) Deprecated. since 1.0.3, for removal in 1.1. override createNewInstance(UriComponents, List) instead
protected T	createNewInstance(UriComponents components, 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(UriComponents components, boolean encoded)
String	toString()
URI	toUri() Creates a URI of the link built by the current builder instance.
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(UriComponents builder)

Creates a new LinkBuilderSupport using the given UriComponents.

Parameters:

builder - must not be null.

LinkBuilderSupport

@Deprecated
protected LinkBuilderSupport(UriComponentsBuilder builder,
                                         List<Affordance> affordances)

Deprecated. since 1.0.3, for removal in 1.1. Use LinkBuilderSupport(UriComponents, List) instead.

Creates a new LinkBuilderSupport using the given UriComponentsBuilder and Affordances.

Parameters:

builder - must not be null.

affordances - must not be null.

LinkBuilderSupport

protected LinkBuilderSupport(UriComponents components,
                             List<Affordance> affordances)

Creates a new LinkBuilderSupport using the given UriComponents and Affordances.

Parameters:

components - must not be null.

affordances - must not be null.

Method Detail

slash

public T slash(@Nullable
               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

Parameters:

object - can be null.

Returns:

slash

protected T slash(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

createNewInstance

@Deprecated
protected T createNewInstance(UriComponentsBuilder builder,
                                          List<Affordance> affordances)

Deprecated. since 1.0.3, for removal in 1.1. override createNewInstance(UriComponents, List) instead

Creates a new concrete LinkBuilder.

Parameters:

builder - must not be null.

affordances - must not be null.

Returns:

toString

public String toString()

Overrides:

toString in class Object

getThis

protected abstract T getThis()

Returns the current concrete instance.

Returns:

createNewInstance

protected T createNewInstance(UriComponents components,
                              List<Affordance> affordances)

Creates a new instance of the sub-class.

Parameters:

builder - will never be null.

Returns: