core/io.spine.core/Signal

Signal

public interface Signal<I extends SignalId, M extends KnownMessage, C extends MessageContext> implements 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.

Parameters

<I>

the type of the signal identifier

<M>

the type of the enclosed messages

<C>

the type of the message context

Functions

asMessageOrigin

public Origin asMessageOrigin()

Obtains this signal as an origin of other signals.

context

public C context()

Obtains the context of the enclosed message.

enclosedMessage

public M enclosedMessage()

Obtains the unpacked form of the enclosed message.

enclosedTypeUrl

public TypeUrl enclosedTypeUrl()

Obtains the type URL of the enclosed message.

getContext

public abstract C getContext()

Obtains the context of the enclosed message.

getId

public abstract I getId()

Obtains the identifier of the message.

getMessage

public abstract Any getMessage()

Obtains the packed version of the enclosed message.

public I id()

Obtains the identifier of the message.

identityBuilder

public Builder identityBuilder()

Creates the builder for identity of the message, by supplying the ID and the type URL of the enclosed message.

public boolean is(Class<? extends 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

public MessageId messageId()

Obtains the ID of this message.

origin

public abstract Optional<Origin> origin()

Obtains the origin of this signal.

parent

public Optional<MessageId> parent()

rootMessage

public abstract MessageId rootMessage()

Obtains the ID of the first message in the chain.

type

public Class<? extends M> type()

Obtains the type of the signal as the type of the enclosedMessage.

Inherited functions

actor

public UserId actor()

The ID of the associated user.

actorContext

public abstract ActorContext actorContext()

The context of the associated user.

instant

public Instant instant()

Obtains the associated time point as Instant.

isAfter

public boolean isAfter(Timestamp bound)

Verifies if associated time is after the passed point in time.

isBefore

public boolean isBefore(Timestamp bound)

Verifies if the associated time is before the passed point in time.

isBetween

public boolean isBetween(Timestamp periodStart, Timestamp periodEnd)

Verifies if the associated time point is within the passed period of time.

localDate

public LocalDate localDate()

Obtains the local date of the instant associated time point}.

localDateTime

public LocalDateTime localDateTime()

Obtains the local date and time of the instant associated time point}.

tenant

public TenantId tenant()

Obtains the ID of the tenant under which the message was created.

timestamp

public abstract Timestamp timestamp()

Obtains the point in time associated with the object.