siren

Class Entity

java.lang.Object

siren.EntityBase

siren.Entity

Direct Known Subclasses:

EmbeddedRepresentationSubEntity

public class Entity
extends EntityBase

An Entity is a URI-addressable resource that has properties and actions associated with it. It may contain sub-entities and navigational links.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.Builder Constructs instances of Entity.

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 Entity instance.
java.util.List<Action>	getActions() Retrieves the actions.
java.util.List<EntityBase>	getEntities() Retrieves the sub-entities.
java.util.List<Link>	getLinks() Retrieves the links.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Retrieves the properties.
int	hashCode() Generates hashcode represented as an integer for the calling Entity 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

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Retrieves the properties.

Returns:

The map of the properties.

getActions

public java.util.List<Action> getActions()

Retrieves the actions.

Returns:

The list of the actions.

getLinks

public java.util.List<Link> getLinks()

Retrieves the links.

Returns:

The list of links.

getEntities

public java.util.List<EntityBase> getEntities()

Retrieves the sub-entities.

Returns:

The list of the sub-entities.

equals

public boolean equals(java.lang.Object obj)

Determines if the instance of Object provided is equal to the calling Entity 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 Entity instance.

Overrides:

hashCode in class EntityBase

Returns:

The hashcode for the calling Entity instance.