siren

Class EntityBase

java.lang.Object

siren.EntityBase

Direct Known Subclasses:

EmbeddedLinkSubEntity, Entity

public abstract class EntityBase
extends java.lang.Object

Represents the common lineage of all entities.

Since:

8/13/17

Author:

jonfreer

Constructor Summary

Constructors

Constructor and Description
EntityBase() Constructs an instance of EntityBase.
EntityBase(java.util.List<java.lang.String> klass, java.lang.String title) Constructs an instance of EntityBase.

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 EntityBase instance.
java.util.List<java.lang.String>	getKlass() Retrieves the class of the entity.
java.lang.String	getTitle() Retrieves the title of the entity.
int	hashCode() Generates hashcode represented as an integer for the calling EntityBase sub-class instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityBase

public EntityBase()

Constructs an instance of EntityBase.

EntityBase

public EntityBase(java.util.List<java.lang.String> klass,
                  java.lang.String title)

Constructs an instance of EntityBase.

Parameters:

klass - Describes the nature of an entity's content based on the current representation. Possible values are implementation-dependent and should be documented.

title - Descriptive text about the entity.

Method Detail

getKlass

public java.util.List<java.lang.String> getKlass()

Retrieves the class of the entity.

Returns:

The class of the entity.

getTitle

public java.lang.String getTitle()

Retrieves the title of the entity.

Returns:

The title of the entity.

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

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 EntityBase sub-class instance.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode for the calling EntityBase sub-class instance.