Package io.wcm.caravan.hal.resource.util

Class HalCuriAugmenter

java.lang.Object

io.wcm.caravan.hal.resource.util.HalCuriAugmenter

@Deprecated
@ProviderType
public final class HalCuriAugmenter
extends Object

Deprecated.

This is replaced by HalDocsAugmenter from the io.wcm.caravan.hal.docs bundle.

Augments a HAL resource by CURI documentation links for links in the main and embedded resources. Pre-defined CURIES in the HAL resource will remain and not overwritten.

Field Summary

Fields

Modifier and Type	Field	Description
static String	LINK_RELATION_CURIES	Deprecated. HAL specific relation for CURI links.

Constructor Summary

Constructors

Constructor	Description
HalCuriAugmenter()	Deprecated.

Method Summary

Modifier and Type	Method	Description
HalCuriAugmenter	augment(HalResource hal)	Deprecated. Augments a HAL resource by CURI links.
Link	get(String name)	Deprecated. Returns the CURI link for a given CURI name.
boolean	has(String name)	Deprecated.
HalCuriAugmenter	register(Link link)	Deprecated. Registers a CURI link.
HalCuriAugmenter	register(String name, String href)	Deprecated. Registers a CURI link by the given name and HREF.
HalCuriAugmenter	unregister(String name)	Deprecated. Unregisters a CURI link.

Methods inherited from class java.lang.Object

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

Field Detail

LINK_RELATION_CURIES

public static final String LINK_RELATION_CURIES

Deprecated.

HAL specific relation for CURI links.

See Also:

Constant Field Values

Constructor Detail

HalCuriAugmenter

public HalCuriAugmenter()

Deprecated.

Method Detail

register

public HalCuriAugmenter register(String name,
                                 String href)

Deprecated.

Registers a CURI link by the given name and HREF.

Parameters:

name - CURI link name

href - Link URI

Returns:

This augmenter

register

public HalCuriAugmenter register(Link link)

Deprecated.

Registers a CURI link.

Parameters:

link - CURI link

Returns:

This augmenter

unregister

public HalCuriAugmenter unregister(String name)

Deprecated.

Unregisters a CURI link.

Parameters:

name - CURI name

Returns:

This augmenter

get

public Link get(String name)

Deprecated.

Returns the CURI link for a given CURI name.

Parameters:

name - CURI name

Returns:

CURI link or null if missing

has

public boolean has(String name)

Deprecated.

Parameters:

name - CURI name

Returns:

True if there is a CURI link registered for the given CURI name

augment

public HalCuriAugmenter augment(HalResource hal)

Deprecated.

Augments a HAL resource by CURI links. Only adds CURIES being registered and referenced in the HAL resource. Will not override existing CURI links.

Parameters:

hal - HAL resource to augment

Returns:

This augmenter