siren

Class EmbeddedLinkSubEntity

java.lang.Object

siren.EntityBase

siren.EmbeddedLinkSubEntity

public class EmbeddedLinkSubEntity
extends EntityBase

A sub-entity containing an href value. One difference is that a sub-entity MUST contain a rel attribute to describe its relationship to the parent entity.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbeddedLinkSubEntity.Builder Constructs an instance of EmbeddedLinkSubEntity.Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines if the instance of Object provided is equal to the calling EmbeddedLinkSubEntity instance.
java.net.URI	getHref() Retrieves the URI of the linked sub-entity.
java.util.List<Relation>	getRel() Retrieves the relationship of the sub-entity to its parent, per Web Linking (RFC5899).
java.lang.String	getType() Retrieves the media type of the linked resource, per Web Linking (RFC5988).
int	hashCode() Generates hashcode represented as an integer for the calling EmbeddedRepresentationSubEntity instance.

Methods inherited from class siren.EntityBase

getKlass, getTitle

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Determines if the instance of Object provided is equal to the calling EmbeddedLinkSubEntity instance.

Overrides:

equals in class EntityBase

Parameters:

obj - The instance of Object being examined.

Returns:

true if the instances are equal; false otherwise.

hashCode

public int hashCode()

Generates hashcode represented as an integer for the calling EmbeddedRepresentationSubEntity instance.

Overrides:

hashCode in class EntityBase

Returns:

The hashcode for the calling EmbeddedLinkSubEntity instance.

getRel

public java.util.List<Relation> getRel()

Retrieves the relationship of the sub-entity to its parent, per Web Linking (RFC5899).

Returns:

The relationship of the sub-entity to its parent.

See Also:

RFC5899

getHref

public java.net.URI getHref()

Retrieves the URI of the linked sub-entity.

Returns:

The URI of the linked sub-entity.

getType

public java.lang.String getType()

Retrieves the media type of the linked resource, per Web Linking (RFC5988). For the syntax, see RFC2045 (section 5.1), RFC4288 (section 4.2), RFC6838 (section 4.2)

Returns:

The media type of the linked resource.