net.openhft.chronicle.wire

Class AbstractEventCfg<E extends AbstractEventCfg<E>>

java.lang.Object

net.openhft.chronicle.wire.SelfDescribingMarshallable

net.openhft.chronicle.wire.AbstractMarshallableCfg

net.openhft.chronicle.wire.AbstractEventCfg<E>

Type Parameters:

E - The type parameter extending AbstractEventCfg

All Implemented Interfaces:

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

public class AbstractEventCfg<E extends AbstractEventCfg<E>>
extends AbstractMarshallableCfg
implements Event<E>

The AbstractEventCfg class represents a generic configuration as an event. It extends the AbstractMarshallableCfg and implements the Event interface. This class provides methods to retrieve and set event properties such as ID, time, and service ID. It also follows the builder pattern, allowing chained method calls.

Field Summary

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

EMPTY

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

DISCARD

Constructor Summary

Constructors

Constructor and Description
AbstractEventCfg()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
@NotNull String	eventId() Retrieves the unique identifier associated with this event.
E	eventId(@NotNull CharSequence eventId) Assigns an identifier to this event.
long	eventTime() Returns the time at which the event which triggered this was generated (e.g.
E	eventTime(long eventTime) Sets the time at which the event which triggered this was generated (e.g.
E	eventTimeNow() Sets the time at which the event which triggered this was generated (e.g.
int	hashCode()
boolean	routedTo(String destServiceId) This method checks if the event is routed to a specific destination service.
@NotNull String	serviceId() This method retrieves the service ID associated with the event, used for event routing.
E	serviceId(String serviceId) This method sets the provided service ID to the instance variable.
String	toString()

Methods inherited from class net.openhft.chronicle.wire.AbstractMarshallableCfg

readMarshallable, unexpectedField, writeMarshallable

Methods inherited from class net.openhft.chronicle.wire.SelfDescribingMarshallable

usesSelfDescribingMessage

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copyEventDetails, updateEvent

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

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

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

$toString, readMarshallable, writeMarshallable

Constructor Detail

AbstractEventCfg

public AbstractEventCfg()

Method Detail

eventId

@NotNull
public @NotNull String eventId()

Description copied from interface: Event

Retrieves the unique identifier associated with this event.

Specified by:

eventId in interface Event<E extends AbstractEventCfg<E>>

Returns:

The unique identifier for this event.

eventId

public E eventId(@NotNull
                 @NotNull CharSequence eventId)

Description copied from interface: Event

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.

Specified by:

eventId in interface Event<E extends AbstractEventCfg<E>>

Parameters:

eventId - The unique identifier to assign to this event.

Returns:

The current instance of the event, facilitating method chaining.

eventTime

public long eventTime()

Description copied from interface: BaseEvent

Returns the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system).

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Specified by:

eventTime in interface BaseEvent<E extends AbstractEventCfg<E>>

Returns:

the time at which the event which triggered this was generated.

eventTime

public E eventTime(long eventTime)

Description copied from interface: BaseEvent

Sets the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system).

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Specified by:

eventTime in interface BaseEvent<E extends AbstractEventCfg<E>>

Parameters:

eventTime - The timestamp to set for the event, in the configured time unit.

Returns:

The current instance of the implementing class.

eventTimeNow

public E eventTimeNow()

Description copied from interface: BaseEvent

Sets the time at which the event which triggered this was generated (e.g. the time an event generated externally to the system first entered the system) to the current time.

By default, the time is represented in nanoseconds. System property 'service.time.unit' can be changed in order to represent time in different units.

Specified by:

eventTimeNow in interface BaseEvent<E extends AbstractEventCfg<E>>

Returns:

this

serviceId

@NotNull
public @NotNull String serviceId()

This method retrieves the service ID associated with the event, used for event routing. It returns the ID of the destination event.

Returns:

The current service ID of this object

serviceId

public E serviceId(String serviceId)

This method sets the provided service ID to the instance variable. It returns the current instance, allowing chained method calls.

Parameters:

serviceId - The new service ID to be set

Returns:

The current instance of AbstractEventCfg class

routedTo

public boolean routedTo(String destServiceId)

This method checks if the event is routed to a specific destination service.

Parameters:

destServiceId - The destination service ID to check against

Returns:

true if the event is routed to the specified service, false otherwise

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object