org.openhubframework.openhub.api.entity

Class SuperEntity<ID extends Serializable>

java.lang.Object

org.openhubframework.openhub.api.entity.SuperEntity<ID>

All Implemented Interfaces:

Serializable, HumanReadable, Identifiable<ID>

Direct Known Subclasses:

DbConfigurationParam, ExternalCall, Message, Request, Response

public abstract class SuperEntity<ID extends Serializable>
extends Object
implements Serializable, Identifiable<ID>, HumanReadable

Basic entity with an identifier property. Used as a base class for all persistent entities.

Since:

2.0

Author:

Petr Juza

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SuperEntity() Creates new entity with null identifier.
protected	SuperEntity(ID id) Creates new entity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Two entities are equal if their ID is equal.
ID	getId() Get unique ID of the entity.
int	hashCode()
boolean	isNew() Return true if entity is new otherwise false.
void	setId(ID id) Sets unique identifier of the entity.
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperEntity

protected SuperEntity(@Nullable
                      ID id)

Creates new entity.

Parameters:

id - The unique identifier

SuperEntity

protected SuperEntity()

Creates new entity with null identifier.

Method Detail

setId

public void setId(@Nullable
                  ID id)

Description copied from interface: Identifiable

Sets unique identifier of the entity.

Specified by:

setId in interface Identifiable<ID extends Serializable>

Parameters:

id - unique identifier

getId

@Nullable
public ID getId()

Get unique ID of the entity.

Specified by:

getId in interface Identifiable<ID extends Serializable>

Returns:

entity's ID

isNew

public boolean isNew()

Return true if entity is new otherwise false.

Returns:

true if entity is new otherwise false.

equals

public boolean equals(@Nullable
                      Object obj)

Two entities are equal if their ID is equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toHumanString

public String toHumanString()

Description copied from interface: HumanReadable

Returns human readable entity identification with start and end round brackets.

Specified by:

toHumanString in interface HumanReadable

Returns:

entity identification

toString

public String toString()

Overrides:

toString in class Object