Package org.apache.juneau.bean.jsonapi

Class JsonApiRelationship

java.lang.Object

org.apache.juneau.bean.jsonapi.JsonApiRelationship

@Marshalled
public class JsonApiRelationship
extends Object

Represents a JSON:API Relationship Object as defined by JSON:API v1.1 § Relationships.

A relationship carries:

• data - resource linkage. Per spec, this can be null, a single JsonApiResourceIdentifier, or a JSON array of identifiers. Modeled here as Object.
• links - related URLs. Each value can be either a JSON string URL or a JsonApiLink object; the field-level JsonApiLinkOrStringSwap swap handles the union.
• meta - free-form meta bag.

See Also:

• juneau-bean-jsonapi

Constructor Summary

Constructors

Constructor	Description
JsonApiRelationship()	Default constructor.

Method Summary

Modifier and Type	Method	Description
Object	getData()	Bean property getter: data.
Map<String,Object>	getLinks()	Bean property getter: links.
Map<String,Object>	getMeta()	Bean property getter: meta.
JsonApiRelationship	putLink(String name, Object value)	Convenience method to add a single link.
JsonApiRelationship	putMeta(String name, Object value)	Convenience method to add a single meta entry.
JsonApiRelationship	setData(Object value)	Bean property setter: data.
JsonApiRelationship	setData(List<JsonApiResourceIdentifier> value)	Typed setter for to-many linkage.
JsonApiRelationship	setData(JsonApiResourceIdentifier value)	Typed setter for single-identifier linkage.
JsonApiRelationship	setLinks(Map<String,Object> value)	Bean property setter: links.
JsonApiRelationship	setMeta(Map<String,Object> value)	Bean property setter: meta.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JsonApiRelationship

public JsonApiRelationship()

Default constructor.

Method Details

getData

public Object getData()

Bean property getter: data.

Resource linkage. Per spec, this may be null, a single JsonApiResourceIdentifier, or a List<JsonApiResourceIdentifier>.

Returns:

The value of the data property, or null if it is not set.

setData

public JsonApiRelationship setData(Object value)

Bean property setter: data.

Parameters:

value - The new value (single identifier, list of identifiers, or null to unset).

Returns:

This object.

setData

public JsonApiRelationship setData(JsonApiResourceIdentifier value)

Typed setter for single-identifier linkage.

Parameters:

value - The identifier. Can be null to unset the property.

Returns:

This object.

setData

public JsonApiRelationship setData(List<JsonApiResourceIdentifier> value)

Typed setter for to-many linkage.

Parameters:

value - The list of identifiers. Can be null to unset the property.

Returns:

This object.

getLinks

@BeanProp("links")
@Swap(JsonApiLinkOrStringSwap.class)
public Map<String,Object> getLinks()

Bean property getter: links.

Per spec, each links value can be either a JSON string URL or a JsonApiLink object.

Returns:

The value of the links property, or null if it is not set.

setLinks

@BeanProp("links")
@Swap(JsonApiLinkOrStringSwap.class)
public JsonApiRelationship setLinks(Map<String,Object> value)

Bean property setter: links.

Parameters:

value - The new value for this property. Can be null to unset the property.

Returns:

This object.

putLink

public JsonApiRelationship putLink(String name,
 Object value)

Convenience method to add a single link.

Parameters:

name - The link name. Can be null (LinkedHashMap tolerates a null key).

value - The link value (a String URL or a JsonApiLink object). Can be null (stored as null).

Returns:

This object.

getMeta

public Map<String,Object> getMeta()

Bean property getter: meta.

Returns:

The value of the meta property, or null if it is not set.

setMeta

public JsonApiRelationship setMeta(Map<String,Object> value)

Bean property setter: meta.

Parameters:

value - The new value for this property. Can be null to unset the property.

Returns:

This object.

putMeta

public JsonApiRelationship putMeta(String name,
 Object value)

Convenience method to add a single meta entry.

Parameters:

name - The meta key. Can be null (LinkedHashMap tolerates a null key).

value - The meta value. Can be null (stored as null).

Returns:

This object.

toString

public String toString()

Overrides:

toString in class Object