de.otto.edison.hal

Class HalRepresentation

java.lang.Object

de.otto.edison.hal.HalRepresentation

public class HalRepresentation
extends java.lang.Object

Representation used to parse and create HAL+JSON documents from Java classes.

Since:

0.1.0

See Also:

hal_specification.html, draft-kelly-json-hal-08

Constructor Summary

Constructors

Constructor and Description
HalRepresentation()
HalRepresentation(Links links) Creates a HalRepresentation having Links
HalRepresentation(Links links, Curies curies) Deprecated. This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0
HalRepresentation(Links links, Embedded embedded) Creates a HalRepresentation with Links and Embedded objects.
HalRepresentation(Links links, Embedded embedded, Curies curies) Deprecated. This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0

Method Summary

Modifier and Type	Method and Description
protected HalRepresentation	add(Links links) Add links to the HalRepresentation.
boolean	equals(java.lang.Object o)
com.fasterxml.jackson.databind.JsonNode	getAttribute(java.lang.String name) Returns the value of an extra attribute as a JsonNode, or null if no such attribute is present.
java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	getAttributes() Returns extra attributes that were not mapped to properties of the HalRepresentation.
Embedded	getEmbedded() Returns the Embedded objects of the HalRepresentation.
Links	getLinks() Returns the Links of the HalRepresentation.
int	hashCode()
java.lang.String	toString()
protected HalRepresentation	withEmbedded(java.lang.String rel, HalRepresentation embeddedItem) Adds an embedded item for a link-relation type to the HalRepresentation.
protected HalRepresentation	withEmbedded(java.lang.String rel, java.util.List<? extends HalRepresentation> embeddedItems) Adds embedded items for a link-relation type to the HalRepresentation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HalRepresentation

public HalRepresentation()

Since:

0.1.0

HalRepresentation

public HalRepresentation(Links links)

Creates a HalRepresentation having Links

Parameters:

links - the Links of the HalRepresentation

Since:

0.1.0

HalRepresentation

@Deprecated
public HalRepresentation(Links links,
                                     Curies curies)

Deprecated. This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0

Creates a HalRepresentation having Links and a Curies that can be used to configure the link-relation types that should always be rendered as an array of links.

Parameters:

links - the Links of the HalRepresentation

curies - the Curies used to resolve curies

Since:

1.0.0

HalRepresentation

public HalRepresentation(Links links,
                         Embedded embedded)

Creates a HalRepresentation with Links and Embedded objects.

If the Links do contain CURIs, the link-relation types of the embedded objects are shortened.

Parameters:

links - the Links of the HalRepresentation

embedded - the Embedded items of the HalRepresentation

Since:

0.1.0

HalRepresentation

@Deprecated
public HalRepresentation(Links links,
                                     Embedded embedded,
                                     Curies curies)

Deprecated. This method will most likely not be required by any users of edison-hal. Please contact me, if you need this, otherwise the constructor will be removed in 3.0.0

Creates a HalRepresentation with Links, Embedded objects and a Curies used to resolve curies from parent representations.

If the Links do contain CURIs, the matching link-relation types of links and embedded objects are shortened.

Parameters:

links - the Links of the HalRepresentation

embedded - the Embedded items of the HalRepresentation

curies - the Curies used to resolve curies

Since:

1.0.0

Method Detail

getLinks

public Links getLinks()

Returns the Links of the HalRepresentation.

Returns:

Links

Since:

0.1.0

add

protected HalRepresentation add(Links links)

Add links to the HalRepresentation.

Links are only added if they are not equivalent to already existing links.

Parameters:

links - links that are added to this HalRepresentation

Returns:

this

getEmbedded

public Embedded getEmbedded()

Returns the Embedded objects of the HalRepresentation.

Returns:

Embedded, possibly beeing empty

getAttributes

public java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> getAttributes()

Returns extra attributes that were not mapped to properties of the HalRepresentation.

Returns:

map containing unmapped attributes

getAttribute

public com.fasterxml.jackson.databind.JsonNode getAttribute(java.lang.String name)

Returns the value of an extra attribute as a JsonNode, or null if no such attribute is present.

Parameters:

name - the name of the attribute

Returns:

JsonNode or null

withEmbedded

protected HalRepresentation withEmbedded(java.lang.String rel,
                                         java.util.List<? extends HalRepresentation> embeddedItems)

Adds embedded items for a link-relation type to the HalRepresentation.

If rel is already present, it is replaced by the new embedded items.

Parameters:

rel - the link-relation type of the embedded items that are added or replaced

embeddedItems - the new values for the specified link-relation type

Returns:

this

Since:

0.5.0

withEmbedded

protected HalRepresentation withEmbedded(java.lang.String rel,
                                         HalRepresentation embeddedItem)

Adds an embedded item for a link-relation type to the HalRepresentation.

The embedded item will be rendered as a single resource object.

If rel is already present, it is replaced by the new embedded items.

Parameters:

rel - the link-relation type of the embedded item that is added or replaced

embeddedItem - the new value for the specified link-relation type

Returns:

this

Since:

2.0.0

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

Since:

0.1.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

0.1.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

0.1.0