RegisteredLogDescriptionsProcessor

RegisteredLogDescriptionsProcessor is responsible for managing storing descriptions of event log groups and their events. Provides functionality to store, retrieve descriptions for groups and their events.

Descriptions are registered and stored in the memory if descriptionRegistrationEnabled is true. Please use it just for com.jetbrains.fus.reporting.schema.EventsSchemeBuilder.buildEventsScheme and tests.

It ensures that event and group descriptions are immutable once registered. If an attempt is made to override an already registered description with a differing value, an exception is thrown.

The processor maintains two internal maps:

  • A map for group descriptions to associate a description with each event log group.

  • A nested map for event descriptions within each group.

Properties

Functions

Link copied to clipboard

Calculates and retrieves the description for a specific event within a group based on the provided group ID and event ID.

Link copied to clipboard

Calculates and retrieves the description for a specified group based on its group ID.

Link copied to clipboard
fun registerEventDescription(groupId: String, eventId: String, description: String?)

Register a description for an event within a specific group if descriptionRegistrationEnabled is true, the description is not empty and not null. Throws an exception if the description for the event already exists and differs from the new one.

Link copied to clipboard
fun registerGroupDescription(groupId: String, description: String?)

Register a description for a specified group if descriptionRegistrationEnabled is true, the description is not empty and not null. Throws an exception if the description for the group already exists and differs from the new one.

Link copied to clipboard

Resets the descriptions of the current instance by clearing all relevant data.