server/io.spine.server.entity.model/CommandHandlingEntityClass

CommandHandlingEntityClass

public abstract class CommandHandlingEntityClass<E extends Entity> extends EntityClass<E> implements CommandHandlingClass<R, H>

Abstract base for entity classes that handle commands.

Inheritors

AggregateClass

ProcessManagerClass

Constructors

CommandHandlingEntityClass

protected void CommandHandlingEntityClass(Class<E> cls)

Functions

commandOutput

public ImmutableSet<EventClass> commandOutput()

Obtains classes of all messages produced as a result of command handling.

commands

public ImmutableSet<CommandClass> commands()

Obtains classes of commands handled by the class.

handlerOf

public CommandHandlerMethod handlerOf(CommandClass commandClass)

Obtains the handler method for the passed command class.

handlesCommand

public boolean handlesCommand(CommandClass commandClass)

rejections

public ImmutableSet<EventClass> rejections()

Obtains classes of rejections that command handling methods of this class throw, or empty set if no rejections are thrown.

Inherited functions

asEntityClass

public static EntityClass<E> asEntityClass<E extends Entity>(Class<E> cls)

Obtains an entity class for the passed raw class.

columns

public final Columns columns()

Obtains the entity columns of this class.

constructor

public final Constructor<E> constructor()

Obtains constructor for the entities of this class.

create

public E create(Object constructionArgument)

Creates new entity.

createFactory

protected EntityFactory<E> createFactory()

Creates a new instance of the factory for creating entities.

defaultState

public final EntityState defaultState()

Obtains the default state for this class of entities.

equals

public boolean equals(Object o)

factory

public final EntityFactory<E> factory()

Obtains the factory for creating entities.

get

protected static ModelClass<T> get<T, M extends ModelClass<T>>(Class<T> rawClass, Class<M> requestedModelClass, Supplier<ModelClass<T>> supplier)

Obtains the model class for the passed raw class.

hashCode

public int hashCode()

idClass

public final Class<? extends Object> idClass()

Obtains the class of IDs used by the entities of this class.

public static Class<I> idClass<I>(Class<? extends Entity> cls)

Obtains the class of identifiers from the passed entity class.

stateClass

public final Class<? extends EntityState> stateClass()

Obtains the class of the state of entities of this class.

stateClassOf

public static Class<S> stateClassOf<S extends EntityState>(Class<? extends Entity> entityClass)

Retrieves the state class of the passed entity class.

stateType

public final MessageType stateType()

Obtains the entity state type.

stateTypeUrl

public final TypeUrl stateTypeUrl()

Obtains type URL of the state of entities of this class.

typeName

public final EntityTypeName typeName()

Obtains the name of this class as an EntityTypeName.

value

public Class<E> value()

Obtains the raw class of the entities.

visibility

public final EntityVisibility visibility()

Obtains the visibility of this entity type as declared in the Protobuf definition.