de.otto.edison.hal

Class Link.Builder

java.lang.Object

de.otto.edison.hal.Link.Builder

Enclosing class:

Link

public static class Link.Builder
extends java.lang.Object

A Builder used to build complex links.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
Link	build() Builds the Link instance.
Link.Builder	withDeprecation(java.lang.String deprecation) Set deprecation attribute.
Link.Builder	withHref(java.lang.String href) Set the href of the linked resource If href is an URI template, the created link is templated and Link.templated will be true.
Link.Builder	withHrefLang(java.lang.String hrefLang) Set the language of the linked resource
Link.Builder	withName(java.lang.String name) Set the name attribute.
Link.Builder	withProfile(java.lang.String profile) Set the profile attribute
Link.Builder	withRel(java.lang.String rel) Set the rel of the linked resource
Link.Builder	withTitle(java.lang.String title) Set the title attribute
Link.Builder	withType(java.lang.String type) Set the media type of the linked resource

Methods inherited from class java.lang.Object

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

Method Detail

withRel

public Link.Builder withRel(java.lang.String rel)

Set the rel of the linked resource

Parameters:

rel - link-relation type

Returns:

this

Since:

0.4.0

withHref

public Link.Builder withHref(java.lang.String href)

Set the href of the linked resource

If href is an URI template, the created link is templated and Link.templated will be true.

Parameters:

href - href

Returns:

this

Since:

0.4.0

withType

public Link.Builder withType(java.lang.String type)

Set the media type of the linked resource

Parameters:

type - media type

Returns:

this

Since:

0.1.0

withHrefLang

public Link.Builder withHrefLang(java.lang.String hrefLang)

Set the language of the linked resource

Parameters:

hrefLang - the hreflang of the Link

Returns:

this

Since:

0.1.0

withTitle

public Link.Builder withTitle(java.lang.String title)

Set the title attribute

Parameters:

title - the title of the linked resource.

Returns:

this

Since:

0.1.0

withName

public Link.Builder withName(java.lang.String name)

Set the name attribute.

Parameters:

name - the name of the linked resource.

Returns:

this

Since:

0.1.0

withProfile

public Link.Builder withProfile(java.lang.String profile)

Set the profile attribute

Parameters:

profile - the profile of the representation

Returns:

this

Since:

0.1.0

withDeprecation

public Link.Builder withDeprecation(java.lang.String deprecation)

Set deprecation attribute.

Its presence indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation.

Parameters:

deprecation - URL pointing to further information

Returns:

this

Since:

0.1.0

build

public Link build()

Builds the Link instance.

Returns:

Link

Since:

0.1.0