org.camunda.bpm.engine.rest.hal

Class HalRelation

java.lang.Object

org.camunda.bpm.engine.rest.hal.HalRelation

public class HalRelation
extends Object

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
protected String	relName the name of the relation
protected Class<?>	resourceType the type of the resource we build a relation to.
protected javax.ws.rs.core.UriBuilder	uriTemplate the url template used by the relation to construct links

Constructor Summary

Constructors

Constructor and Description
HalRelation()

Method Summary

Methods

Modifier and Type	Method and Description
static HalRelation	build(String relName, Class<?> resourceType, javax.ws.rs.core.UriBuilder urlTemplate) Build a relation to a resource.
String	getRelName()
Class<?>	getResourceType()
javax.ws.rs.core.UriBuilder	getUriTemplate()

Methods inherited from class java.lang.Object

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

Field Detail

relName

protected String relName

the name of the relation

uriTemplate

protected javax.ws.rs.core.UriBuilder uriTemplate

the url template used by the relation to construct links

resourceType

protected Class<?> resourceType

the type of the resource we build a relation to.

Constructor Detail

HalRelation

public HalRelation()

Method Detail

build

public static HalRelation build(String relName,
                Class<?> resourceType,
                javax.ws.rs.core.UriBuilder urlTemplate)

Build a relation to a resource.

Parameters:

relName - the name of the relation.

resourceType - the type of the resource

Returns:

the relation

getRelName

public String getRelName()

getUriTemplate

public javax.ws.rs.core.UriBuilder getUriTemplate()

getResourceType

public Class<?> getResourceType()