io.hypersistence.optimizer.core.event.persistence

Enum EventCategory

java.lang.Object

java.lang.Enum<EventCategory>

io.hypersistence.optimizer.core.event.persistence.EventCategory

All Implemented Interfaces:

Serializable, Comparable<EventCategory>

public enum EventCategory
extends Enum<EventCategory>

The EventCategory classifies an Event based on the phase during which it is emitted, so that configuration and mapping events (detected once, at bootstrap) can be told apart from runtime events (emitted continuously while the application runs).

The classification is based on the fully qualified name of the Event class, so it does not require a compile-time dependency on every concrete event type.

Since:

2.14.0

Author:

Vlad Mihalcea

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIGURATION Configuration-related events, detected when scanning the JPA/Hibernate configuration.
MAPPING Mapping-related events, detected when scanning the entity mappings.
RUNTIME Runtime events, emitted while the application is executing (e.g.

Method Summary

Modifier and Type	Method and Description
static EventCategory	of(Event event) Resolve the EventCategory of the provided Event.
static EventCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static EventCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONFIGURATION

public static final EventCategory CONFIGURATION

Configuration-related events, detected when scanning the JPA/Hibernate configuration.

MAPPING

public static final EventCategory MAPPING

Mapping-related events, detected when scanning the entity mappings.

RUNTIME

public static final EventCategory RUNTIME

Runtime events, emitted while the application is executing (e.g. slow queries, N+1 issues).

Method Detail

values

public static EventCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EventCategory c : EventCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EventCategory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

of

public static EventCategory of(Event event)

Resolve the EventCategory of the provided Event.

Parameters:

event - the Event to classify

Returns:

the EventCategory of the provided Event