Add default event priority + update javadoc

This commit is contained in:
JeremyStar™ 2024-06-10 19:25:13 +02:00
parent d3f9f107a1
commit b24d7c5473
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D

View file

@ -19,40 +19,63 @@
package de.staropensource.sosengine.base.classes;
import de.staropensource.sosengine.base.annotations.EventListener;
/**
* Determines in which order events are processed.
*
* @since 1-alpha0
*/
@SuppressWarnings("unused")
public enum EventPriority {
/**
* Events with this priority are processed first.
* {@link EventListener}s with this priority are processed first.
* This event is exclusive to subsystems and should not be used by applications.
*
* @since 1-alpha0
*/
EXTREMELY_IMPORTANT,
/**
* Events with this priority are processed after {@code EXTREMELY_IMPORTANT}.
* {@link EventListener}s with this priority are executed first.
*
* @since 1-alpha0
*/
VERY_IMPORTANT,
/**
* Events with this priority are processed after {@code VERY_IMPORTANT}.
* {@link EventListener}s with this priority are executed second.
*
* @since 1-alpha0
*/
IMPORTANT,
/**
* Events with this priority are processed after {@code IMPORTANT}.
* The default event priority, {@link EventListener}s with this priority are executed third.
*
* @since 1-alpha0
*/
DEFAULT,
/**
* {@link EventListener}s with this priority are executed fourth.
*
* @since 1-alpha0
*/
UNIMPORTANT,
/**
* Events with this priority are processed after {@code UNIMPORTANT}.
* {@link EventListener}s with this priority are executed fifth.
*
* @since 1-alpha0
*/
VERY_UNIMPORTANT,
/**
* Events with this priority are processed last.
* {@link EventListener}s with this priority are processed last.
* This event is exclusive to subsystems and should not be used by applications.
*
* @since 1-alpha0
*/
EXTREMELY_UNIMPORTANT,
}