io.spine.server.entity

Class StorageConverter<I,E extends Entity<I,S>,S extends io.spine.base.EntityState>

java.lang.Object

com.google.common.base.Converter<E,io.spine.server.entity.EntityRecord>

io.spine.server.entity.StorageConverter<I,E,S>

All Implemented Interfaces:

java.io.Serializable, java.util.function.Function<E,io.spine.server.entity.EntityRecord>

public abstract class StorageConverter<I,E extends Entity<I,S>,S extends io.spine.base.EntityState>
extends com.google.common.base.Converter<E,io.spine.server.entity.EntityRecord>
implements java.io.Serializable

An abstract base for converters of entities into EntityRecord.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StorageConverter(io.spine.type.TypeUrl entityStateType, EntityFactory<E> factory, com.google.protobuf.FieldMask fieldMask)

Method Summary

Modifier and Type	Method and Description
protected E	doBackward(io.spine.server.entity.EntityRecord entityRecord)
protected io.spine.server.entity.EntityRecord	doForward(E entity)
protected EntityFactory<E>	entityFactory() Obtains the entity factory used by the converter.
protected io.spine.type.TypeUrl	entityStateType() Obtains the type URL of the state of entities which this converter builds.
boolean	equals(@Nullable java.lang.Object obj)
protected com.google.protobuf.FieldMask	fieldMask() Obtains the field mask used by this converter to trim the state of entities before the state is injected into entities.
int	hashCode()
protected abstract void	injectState(E entity, S state, io.spine.server.entity.EntityRecord entityRecord) Derived classes must implement providing state injection into the passed entity.
protected void	updateBuilder(io.spine.server.entity.EntityRecord.Builder builder, E entity) Derived classes may override to additionally tune the passed entity builder.
abstract StorageConverter<I,E,S>	withFieldMask(com.google.protobuf.FieldMask fieldMask) Creates a copy of this converter modified with the passed filed mask.

Methods inherited from class com.google.common.base.Converter

andThen, apply, convert, convertAll, from, identity, reverse

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

StorageConverter

protected StorageConverter(io.spine.type.TypeUrl entityStateType,
                           EntityFactory<E> factory,
                           com.google.protobuf.FieldMask fieldMask)

Method Detail

entityStateType

protected io.spine.type.TypeUrl entityStateType()

Obtains the type URL of the state of entities which this converter builds.

entityFactory

protected EntityFactory<E> entityFactory()

Obtains the entity factory used by the converter.

fieldMask

protected com.google.protobuf.FieldMask fieldMask()

Obtains the field mask used by this converter to trim the state of entities before the state is injected into entities.

withFieldMask

public abstract StorageConverter<I,E,S> withFieldMask(com.google.protobuf.FieldMask fieldMask)

Creates a copy of this converter modified with the passed filed mask.

doForward

protected io.spine.server.entity.EntityRecord doForward(E entity)

Specified by:

doForward in class com.google.common.base.Converter<E extends Entity<I,S>,io.spine.server.entity.EntityRecord>

doBackward

protected E doBackward(io.spine.server.entity.EntityRecord entityRecord)

Specified by:

doBackward in class com.google.common.base.Converter<E extends Entity<I,S>,io.spine.server.entity.EntityRecord>

updateBuilder

protected void updateBuilder(io.spine.server.entity.EntityRecord.Builder builder,
                             E entity)

Derived classes may override to additionally tune the passed entity builder.

Default implementation does nothing.

Parameters:

builder - the entity builder to update

entity - the entity which data is passed to the EntityRecord we are building

injectState

protected abstract void injectState(E entity,
                                    S state,
                                    io.spine.server.entity.EntityRecord entityRecord)

Derived classes must implement providing state injection into the passed entity.

Parameters:

entity - the entity into which inject the state

state - the state message extracted from the record

entityRecord - the record which may contain additional properties for the entity

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(@Nullable java.lang.Object obj)

Overrides:

equals in class com.google.common.base.Converter<E extends Entity<I,S>,io.spine.server.entity.EntityRecord>