BaseEventId

sealed class BaseEventId

Represents a base class for event identifiers used in the event logging framework.

This class provides a common structure for registering and managing event identifiers within specific EventLogGroup contexts. Each event is associated with a unique eventId, a group, and a description. The description must be a non-empty string, and an exception will be thrown if the description is not provided or is empty. Upon initialization, the event description is registered using RegisteredLogDescriptionsProcessor.registerEventDescription.

Parameters

group

The EventLogGroup to which this event belongs.

eventId

A unique identifier for this event within the given group.

description

A non-empty and not null description of this event, providing additional information about its purpose. The description is registered at event group initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false. descriptionRegistrationEnabled is true just for EventsSchemeBuilder.buildEventsScheme and tests

Throws

If the description is empty.

Inheritors

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun getFields(): List<EventField<*>>