siren

Class EmbeddedRepresentationSubEntity

java.lang.Object

siren.EntityBase

siren.Entity

siren.EmbeddedRepresentationSubEntity

public class EmbeddedRepresentationSubEntity
extends Entity

An embedded entity representation that contains all the characteristics of a typical entity. 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	EmbeddedRepresentationSubEntity.Builder Constructs an instance of EmbeddedRepresentationSubEntity.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 EmbeddedRepresentationSubEntity instance.
java.util.List<Relation>	getRel() Retrieves the relationship of the sub-entity to its parent, per Web Linking (RFC5899).
int	hashCode() Generates hashcode represented as an integer for the calling EmbeddedRepresentationSubEntity instance.

Methods inherited from class siren.Entity

getActions, getEntities, getLinks, getProperties

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 EmbeddedRepresentationSubEntity instance.

Overrides:

equals in class Entity

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 Entity

Returns:

The hashcode for the calling EmbeddedRepresentationSubEntity instance.

getRel

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

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

Returns:

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

See Also:

RFC5899