io.spine.core

Class Events

java.lang.Object

io.spine.core.Events

@SPI
public final class Events
extends java.lang.Object

Utility class for working with Event objects.

Method Summary

Modifier and Type	Method and Description
static io.spine.core.EventId	checkValid(io.spine.core.EventId id) Deprecated. please use Preconditions2.checkNotDefaultArg(Message)
static io.spine.base.EventMessage	ensureMessage(com.google.protobuf.Message eventOrMessage) Extracts an event message if the passed instance is an Event object or Any, otherwise returns the passed message.
static io.spine.core.EventId	generateId() Creates a new EventId based on random UUID.
static io.spine.string.Stringifier<io.spine.core.EventId>	idStringifier() Obtains the stringifier for event IDs.
static <M extends io.spine.base.EventMessage> java.lang.Iterable<M>	nothing() Creates an empty Iterable over the messages of the type <M>.
static io.spine.core.Event	toExternal(io.spine.core.Event event) Marks the given event as external.
static com.google.common.collect.ImmutableList<io.spine.core.Event>	toExternal(java.util.List<io.spine.core.Event> events) Marks all the given events as external.

Methods inherited from class java.lang.Object

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

Method Detail

generateId

public static io.spine.core.EventId generateId()

Creates a new EventId based on random UUID.

Returns:

new UUID-based event ID

ensureMessage

public static io.spine.base.EventMessage ensureMessage(com.google.protobuf.Message eventOrMessage)

Extracts an event message if the passed instance is an Event object or Any, otherwise returns the passed message.

idStringifier

public static io.spine.string.Stringifier<io.spine.core.EventId> idStringifier()

Obtains the stringifier for event IDs.

checkValid

@Deprecated
public static io.spine.core.EventId checkValid(io.spine.core.EventId id)

Deprecated. please use Preconditions2.checkNotDefaultArg(Message)

Ensures that the passed ID is valid.

Parameters:

id - an ID to check

Throws:

java.lang.IllegalArgumentException - if the ID string value is empty or blank

nothing

public static <M extends io.spine.base.EventMessage> java.lang.Iterable<M> nothing()

Creates an empty Iterable over the messages of the type <M>.

This method is useful for returning empty result from reacting methods.

Type Parameters:

M - the type of messages

Returns:

empty Iterable

toExternal

public static com.google.common.collect.ImmutableList<io.spine.core.Event> toExternal(java.util.List<io.spine.core.Event> events)

Marks all the given events as external.

The order of the events is preserved in the output list.

toExternal

public static io.spine.core.Event toExternal(io.spine.core.Event event)

Marks the given event as external.