org.resthub.web.springmvc.router.hateoas

Class RouterLinkBuilder

java.lang.Object

org.resthub.web.springmvc.router.hateoas.RouterLinkBuilder

All Implemented Interfaces:

org.springframework.hateoas.LinkBuilder

public class RouterLinkBuilder
extends Object
implements org.springframework.hateoas.LinkBuilder

SpringMVC-Router's own take on Spring-HATEOAS LinkBuilder. The RouterLinkBuilder helps you build links to Controller+Action+Arguments when using Spring HATEOAS. This class implements the LinkBuilder interface, but you should use methods with action names and/or controller names for better performance and determinism.

Author:

Brian Clozel

See Also:

Spring HATEOAS, LinkBuilder

Constructor Summary

Constructors

Constructor and Description
RouterLinkBuilder(String controllerAction)

Method Summary

Methods

Modifier and Type	Method and Description
RouterLinkBuilder	action(String actionName)
static RouterLinkBuilder	linkTo(Class<?> controller)
static RouterLinkBuilder	linkTo(String controllerAction)
static RouterLinkBuilder	linkTo(String controllerName, String actionName)
RouterLinkBuilder	slash(org.springframework.hateoas.Identifiable<?> identifiable)
RouterLinkBuilder	slash(Object object)
RouterLinkBuilder	slash(String name, org.springframework.hateoas.Identifiable<?> identifiable)
RouterLinkBuilder	slash(String name, Object object)
String	toString()
URI	toUri()
org.springframework.hateoas.Link	withRel(String rel)
org.springframework.hateoas.Link	withSelfRel()

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterLinkBuilder

public RouterLinkBuilder(String controllerAction)

Method Detail

linkTo

public static RouterLinkBuilder linkTo(String controllerAction)

linkTo

public static RouterLinkBuilder linkTo(String controllerName,
                       String actionName)

linkTo

public static RouterLinkBuilder linkTo(Class<?> controller)

action

public RouterLinkBuilder action(String actionName)

slash

public RouterLinkBuilder slash(Object object)

Specified by:

slash in interface org.springframework.hateoas.LinkBuilder

slash

public RouterLinkBuilder slash(String name,
                      Object object)

slash

public RouterLinkBuilder slash(org.springframework.hateoas.Identifiable<?> identifiable)

Specified by:

slash in interface org.springframework.hateoas.LinkBuilder

slash

public RouterLinkBuilder slash(String name,
                      org.springframework.hateoas.Identifiable<?> identifiable)

toUri

public URI toUri()

Specified by:

toUri in interface org.springframework.hateoas.LinkBuilder

toString

public String toString()

Overrides:

toString in class Object

withRel

public org.springframework.hateoas.Link withRel(String rel)

Specified by:

withRel in interface org.springframework.hateoas.LinkBuilder

withSelfRel

public org.springframework.hateoas.Link withSelfRel()

Specified by:

withSelfRel in interface org.springframework.hateoas.LinkBuilder