io.spine.core

Interface Signal<I,M extends io.spine.base.KnownMessage,C extends io.spine.base.MessageContext>

Type Parameters:

I - the type of the signal identifier

M - the type of the enclosed messages

C - the type of the message context

All Superinterfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, io.spine.base.SerializableMessage, WithActor, WithTime

@SPI
 @Immutable
 @GeneratedMixin
public interface Signal<I,M extends io.spine.base.KnownMessage,C extends io.spine.base.MessageContext>
extends io.spine.base.SerializableMessage, WithActor, WithTime

A message which can be dispatched and cause other messages.

A signal message travels through the system just like an electronic signal travels through a neural network. It cases the system to change its state either directly or by exciting other signals.

A signal message may originate from outside the system, from a user, or from a policy implemented in the system.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.protobuf.Message

com.google.protobuf.Message.Builder

Method Summary

Modifier and Type	Method and Description
default io.spine.core.Origin	asMessageOrigin() Obtains this signal as an origin of other signals.
default C	context() Obtains the context of the enclosed message.
default M	enclosedMessage() Obtains the unpacked form of the enclosed message.
default io.spine.type.TypeUrl	enclosedTypeUrl() Obtains the type URL of the enclosed message.
C	getContext() Obtains the context of the enclosed message.
I	getId() Obtains the identifier of the message.
com.google.protobuf.Any	getMessage() Obtains the packed version of the enclosed message.
default I	id() Obtains the identifier of the message.
default boolean	is(java.lang.Class<? extends com.google.protobuf.Message> enclosedMessageClass) Verifies if the enclosed message has the same type as the passed, or the passed type is the super-type of the message.
default io.spine.core.MessageId	messageId() Obtains the ID of this message.
java.util.Optional<io.spine.core.Origin>	origin() Obtains the origin of this signal.
default java.util.Optional<io.spine.core.MessageId>	parent()
io.spine.core.MessageId	rootMessage() Obtains the ID of the first message in the chain.
default java.lang.Class<? extends M>	type() Obtains the type of the signal as the type of the enclosed Message.

Methods inherited from interface com.google.protobuf.Message

equals, getParserForType, hashCode, newBuilderForType, toBuilder, toString

Methods inherited from interface com.google.protobuf.MessageLite

getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface io.spine.core.WithActor

actor, actorContext, tenant

Methods inherited from interface io.spine.core.WithTime

instant, isAfter, isBefore, isBetween, localDate, localDateTime, timestamp

Method Detail

getId

I getId()

Obtains the identifier of the message.

getMessage

com.google.protobuf.Any getMessage()

Obtains the packed version of the enclosed message.

See Also:

Signal.enclosedMessage()

getContext

C getContext()

Obtains the context of the enclosed message.

id

default I id()

Obtains the identifier of the message.

type

default java.lang.Class<? extends M> type()

Obtains the type of the signal as the type of the enclosed Message.

enclosedMessage

default M enclosedMessage()

Obtains the unpacked form of the enclosed message.

See Also:

Signal.getMessage()

context

default C context()

Obtains the context of the enclosed message.

enclosedTypeUrl

default io.spine.type.TypeUrl enclosedTypeUrl()

Obtains the type URL of the enclosed message.

is

default boolean is(java.lang.Class<? extends com.google.protobuf.Message> enclosedMessageClass)

Verifies if the enclosed message has the same type as the passed, or the passed type is the super-type of the message.

messageId

default io.spine.core.MessageId messageId()

Obtains the ID of this message.

asMessageOrigin

default io.spine.core.Origin asMessageOrigin()

Obtains this signal as an origin of other signals.

This origin is assigned to any signal message produced as a reaction to this one.

origin

java.util.Optional<io.spine.core.Origin> origin()

Obtains the origin of this signal.

Returns:

origin of this signal or Optional.empty() if this signal is posted directly by an actor

rootMessage

io.spine.core.MessageId rootMessage()

Obtains the ID of the first message in the chain.

The root message is always produced by an actor directly. Tenant and actor of the root message define the tenant and actor of the whole chain.

parent

default java.util.Optional<io.spine.core.MessageId> parent()