Package 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	Description
protected String	relName	the name of the relation
protected Class<?>	resourceType	the type of the resource we build a relation to.
protected jakarta.ws.rs.core.UriBuilder	uriTemplate	the url template used by the relation to construct links

Constructor Summary

Constructors

Constructor	Description
HalRelation()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

relName

protected String relName

the name of the relation

uriTemplate

protected jakarta.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 Details

HalRelation

public HalRelation()

Method Details

build

public static HalRelation build(String relName,
 Class<?> resourceType,
 jakarta.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 jakarta.ws.rs.core.UriBuilder getUriTemplate()

getResourceType

public Class<?> getResourceType()