io.spine.server.entity

Class AbstractVersionableEntity<I,S extends com.google.protobuf.Message>

java.lang.Object

io.spine.server.entity.AbstractEntity<I,S>

io.spine.server.entity.AbstractVersionableEntity<I,S>

Type Parameters:

I - the type of the entity ID

S - the type of the entity state

All Implemented Interfaces:

Entity<I,S>, EntityWithLifecycle<I,S>, VersionableEntity<I,S>, WithLifecycle

Direct Known Subclasses:

TransactionalEntity

public abstract class AbstractVersionableEntity<I,S extends com.google.protobuf.Message>
extends AbstractEntity<I,S>
implements VersionableEntity<I,S>, EntityWithLifecycle<I,S>

An abstract base for entities with versions.

The entity keeps only its latest state and version information associated with this state.

Nested Class Summary

Nested classes/interfaces inherited from interface io.spine.server.entity.Entity

Entity.GenericParameter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVersionableEntity(I id) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	checkNotArchived() Ensures that the entity is not marked as archived.
protected void	checkNotDeleted() Ensures that the entity is not marked as deleted.
boolean	equals(java.lang.Object o)
io.spine.server.entity.LifecycleFlags	getLifecycleFlags() Obtains current lifecycle flags.
io.spine.core.Version	getVersion() Obtains the version of the entity.
int	hashCode()
boolean	isArchived() Tests whether the entity is marked as archived.
boolean	isDeleted() Tests whether the entity is marked as deleted.
boolean	lifecycleFlagsChanged() Tells whether lifecycle flags of the entity changed since its initialization.
protected void	setArchived(boolean archived) Sets archived status flag to the passed value.
protected void	setDeleted(boolean deleted) Sets deleted status flag to the passed value.
protected int	versionNumber() Obtains the version number of the entity.
com.google.protobuf.Timestamp	whenModified() Obtains timestamp of the entity version.

Methods inherited from class io.spine.server.entity.AbstractEntity

checkEntityState, getDefaultState, getId, getState, idAsString, thisClass, toString, updateState

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.entity.Entity

getId, getState, idAsString

Methods inherited from interface io.spine.server.entity.WithLifecycle

isActive

Constructor Detail

AbstractVersionableEntity

protected AbstractVersionableEntity(I id)

Creates a new instance.

Upon construction the entity has:

• The version number is set to zero.
• Lifecycle flag are cleared.

Parameters:

id - the ID for the new instance

Throws:

java.lang.IllegalArgumentException - if the ID is not of one of the supported types

Method Detail

lifecycleFlagsChanged

public boolean lifecycleFlagsChanged()

Description copied from interface: EntityWithLifecycle

Tells whether lifecycle flags of the entity changed since its initialization.

Specified by:

lifecycleFlagsChanged in interface EntityWithLifecycle<I,S extends com.google.protobuf.Message>

versionNumber

protected int versionNumber()

Obtains the version number of the entity.

getVersion

public io.spine.core.Version getVersion()

Description copied from interface: VersionableEntity

Obtains the version of the entity.

Specified by:

getVersion in interface VersionableEntity<I,S extends com.google.protobuf.Message>

whenModified

public com.google.protobuf.Timestamp whenModified()

Obtains timestamp of the entity version.

getLifecycleFlags

public io.spine.server.entity.LifecycleFlags getLifecycleFlags()

Description copied from interface: WithLifecycle

Obtains current lifecycle flags.

Specified by:

getLifecycleFlags in interface WithLifecycle

isArchived

public final boolean isArchived()

Tests whether the entity is marked as archived.

Specified by:

isArchived in interface EntityWithLifecycle<I,S extends com.google.protobuf.Message>

Specified by:

isArchived in interface WithLifecycle

Returns:

true if the entity is archived, false otherwise

setArchived

protected void setArchived(boolean archived)

Sets archived status flag to the passed value.

isDeleted

public final boolean isDeleted()

Tests whether the entity is marked as deleted.

Specified by:

isDeleted in interface EntityWithLifecycle<I,S extends com.google.protobuf.Message>

Specified by:

isDeleted in interface WithLifecycle

Returns:

true if the entity is deleted, false otherwise

setDeleted

protected void setDeleted(boolean deleted)

Sets deleted status flag to the passed value.

checkNotArchived

protected void checkNotArchived()
                         throws io.spine.server.entity.rejection.CannotModifyArchivedEntity

Ensures that the entity is not marked as archived.

Throws:

io.spine.server.entity.rejection.CannotModifyArchivedEntity - if the entity in in the archived status

See Also:

AbstractVersionableEntity.getLifecycleFlags(), LifecycleFlags.getArchived()

checkNotDeleted

protected void checkNotDeleted()
                        throws io.spine.server.entity.rejection.CannotModifyDeletedEntity

Ensures that the entity is not marked as deleted.

Throws:

io.spine.server.entity.rejection.CannotModifyDeletedEntity - if the entity is marked as deleted

See Also:

AbstractVersionableEntity.getLifecycleFlags(), LifecycleFlags.getDeleted()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractEntity<I,S extends com.google.protobuf.Message>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractEntity<I,S extends com.google.protobuf.Message>