Package dev.siroshun.event4j.api.priority

Record Class Priority

java.lang.Object

java.lang.Record

dev.siroshun.event4j.api.priority.Priority

Record Components:

value - the priority value

All Implemented Interfaces:

Comparable<Priority>

public record Priority(int value)
extends Record
implements Comparable<Priority>

An interface to set the listener's priority.

Priority is used to determine the order of listener calls.

Priority is compared by Integer.compare(int, int). The smaller value, the listener is called earlier; the larger value, it is called later. For the same value, it is not defined which is called first.

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<Priority>	COMPARATOR	A Comparator to compare two Priority.
static final Priority	HIGH	Priority value: 64
static final Priority	LOW	Priority value: -64
static final Priority	NORMAL	Priority value: 0

Constructor Summary

Constructors

Constructor	Description
Priority(int value)	Creates an instance of a Priority record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NotNull Priority o)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
int	value()	Returns the value of the value record component.
static @NotNull Priority	value(int value)	Creates a new priority.

Methods inherited from class java.lang.Object

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

Field Details

COMPARATOR

public static final Comparator<Priority> COMPARATOR

A Comparator to compare two Priority.

LOW

public static final Priority LOW

Priority value: -64

NORMAL

public static final Priority NORMAL

Priority value: 0

HIGH

public static final Priority HIGH

Priority value: 64

Constructor Details

Priority

public Priority(int value)

Creates an instance of a Priority record class.

Parameters:

value - the value for the value record component

Method Details

value

@NotNull
public static @NotNull Priority value(int value)

Creates a new priority.

Parameters:

value - the priority value

Returns:

the priority

compareTo

public int compareTo(@NotNull
 @NotNull Priority o)

Specified by:

compareTo in interface Comparable<Priority>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

value

public int value()

Returns the value of the value record component.

Returns:

the value of the value record component