Module io.github.teceli.resiliencia.patterns

Package io.github.teceli.resiliencia.patterns.ratelimiter

Record Class RateLimiterEvent.Permitted

java.lang.Object

java.lang.Record

io.github.teceli.resiliencia.patterns.ratelimiter.RateLimiterEvent.Permitted

All Implemented Interfaces:

ResilienceEvent, RateLimiterEvent

Enclosing interface:

RateLimiterEvent

public static record RateLimiterEvent.Permitted(Instant timestamp, String name, int remainingPermits)
extends Record
implements RateLimiterEvent

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.teceli.resiliencia.patterns.ratelimiter.RateLimiterEvent

RateLimiterEvent.Permitted, RateLimiterEvent.Rejected

Nested classes/interfaces inherited from interface io.github.teceli.resiliencia.core.spi.ResilienceEvent

ResilienceEvent.Listener

Constructor Summary

Constructors

Constructor	Description
Permitted(Instant timestamp, String name, int remainingPermits)	Creates an instance of a Permitted record class.

Method Summary

Modifier and Type	Method	Description
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.
String	name()	Returns the value of the name record component.
int	remainingPermits()	Returns the value of the remainingPermits record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.teceli.resiliencia.patterns.ratelimiter.RateLimiterEvent

patternName

Constructor Details

Permitted

public Permitted(Instant timestamp,
 String name,
 int remainingPermits)

Creates an instance of a Permitted record class.

Parameters:

timestamp - the value for the timestamp record component

name - the value for the name record component

remainingPermits - the value for the remainingPermits record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface ResilienceEvent

Returns:

the value of the timestamp record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

remainingPermits

public int remainingPermits()

Returns the value of the remainingPermits record component.

Returns:

the value of the remainingPermits record component