net.openhft.chronicle.wire

Interface Event<E extends Event<E>>

Type Parameters:

E - The type of the implementing event class, following the self-referential generic pattern.

All Superinterfaces:

BaseEvent<E>, net.openhft.chronicle.bytes.CommonMarshallable, Marshallable, ReadMarshallable, net.openhft.chronicle.core.io.Resettable, WriteMarshallable, WriteValue

All Known Implementing Classes:

AbstractEventCfg

public interface Event<E extends Event<E>>
extends BaseEvent<E>

This interface defines the structure and behavior of an event within a system. It extends BaseEvent, thereby inheriting methods related to time management, and adds methods specific to event identification and manipulation.

NOTE: Only use this interface if the eventId is required as the eventTime is sufficient in most cases

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
static void	copyEventDetails(Event<?> from, Event<?> to) Copies essential details from one event to another.
default @NotNull CharSequence	eventId() Retrieves the unique identifier associated with this event.
default E	eventId(@NotNull CharSequence eventId) Assigns an identifier to this event.
default E	updateEvent(String eventName) Updates the event with a new name, and if the event time is not already set, updates the event time to the current system time.

Methods inherited from interface net.openhft.chronicle.wire.BaseEvent

eventTime, eventTime, eventTimeNow, updateEvent

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Method Detail

eventId

@NotNull
default @NotNull CharSequence eventId()

Retrieves the unique identifier associated with this event.

Returns:

The unique identifier for this event.

eventId

default E eventId(@NotNull
                  @NotNull CharSequence eventId)

Assigns an identifier to this event. The provided identifier must not be null. This method can be used to explicitly set or change the event's identifier.

Parameters:

eventId - The unique identifier to assign to this event.

Returns:

The current instance of the event, facilitating method chaining.

updateEvent

default E updateEvent(String eventName)

Updates the event with a new name, and if the event time is not already set, updates the event time to the current system time. This method is useful for renaming events and ensuring they have a valid timestamp.

Parameters:

eventName - The new name to be assigned to the event.

Returns:

The current instance of the implementing class, with any necessary updates applied.

copyEventDetails

static void copyEventDetails(Event<?> from,
                             Event<?> to)

Copies essential details from one event to another. This method is preferred over direct field access as it provides a more controlled way of transferring details between events, and facilitates future changes to the event structure.

Parameters:

from - The source event from which details are copied.

to - The target event to which details are copied.