Record Class QueueOptions

java.lang.Object

java.lang.Record

org.mineskin.QueueOptions

Record Components:

scheduler - Executor service to run the queue - this should be a single-threaded scheduler

intervalMillis - Interval in milliseconds between each request

concurrency - Maximum number of concurrent requests

All Implemented Interfaces:

IQueueOptions

public record QueueOptions(ScheduledExecutorService scheduler, int intervalMillis, int concurrency)
extends Record
implements IQueueOptions

Constructor Summary

Constructors

Constructor	Description
QueueOptions(ScheduledExecutorService scheduler, int intervalMillis, int concurrency)	Creates an instance of a QueueOptions record class.

Method Summary

Modifier and Type	Method	Description
int	concurrency()	Returns the value of the concurrency record component.
static AutoGenerateQueueOptions	createAutoGenerate()	Deprecated. use GenerateQueueOptions.createAuto()
static AutoGenerateQueueOptions	createAutoGenerate(ScheduledExecutorService scheduler)	Deprecated. use GenerateQueueOptions.createAuto(ScheduledExecutorService)
static QueueOptions	createGenerate()	Deprecated. use GenerateQueueOptions.create()
static QueueOptions	createGenerate(ScheduledExecutorService scheduler)	Deprecated. use GenerateQueueOptions.create(ScheduledExecutorService)
static QueueOptions	createGet()	Deprecated. use GetQueueOptions.create()
static QueueOptions	createGet(ScheduledExecutorService scheduler)	Deprecated. use GetQueueOptions.create(ScheduledExecutorService)
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.
int	intervalMillis()	Returns the value of the intervalMillis record component.
ScheduledExecutorService	scheduler()	Returns the value of the scheduler record component.
final String	toString()	Returns a string representation of this record class.
QueueOptions	withConcurrency(int concurrency)
QueueOptions	withInterval(int interval, TimeUnit unit)

Methods inherited from class Object

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

Methods inherited from interface IQueueOptions

reportFailure

Constructor Details

QueueOptions

public QueueOptions(ScheduledExecutorService scheduler,
 int intervalMillis,
 int concurrency)

Creates an instance of a QueueOptions record class.

Parameters:

scheduler - the value for the scheduler record component

intervalMillis - the value for the intervalMillis record component

concurrency - the value for the concurrency record component

Method Details

createGenerate

@Deprecated
public static QueueOptions createGenerate(ScheduledExecutorService scheduler)

Deprecated.

use GenerateQueueOptions.create(ScheduledExecutorService)

Creates a QueueOptions instance with default values for generate requests (200ms interval, 1 concurrent request).

createGenerate

@Deprecated
public static QueueOptions createGenerate()

Deprecated.

use GenerateQueueOptions.create()

Creates a QueueOptions instance with default values for generate requests (200ms interval, 1 concurrent request).

createAutoGenerate

@Deprecated
public static AutoGenerateQueueOptions createAutoGenerate(ScheduledExecutorService scheduler)

Deprecated.

use GenerateQueueOptions.createAuto(ScheduledExecutorService)

Creates a QueueOptions instance that automatically adjusts the interval and concurrency based on the user's allowance.

See Also:

• AutoGenerateQueueOptions

createAutoGenerate

@Deprecated
public static AutoGenerateQueueOptions createAutoGenerate()

Deprecated.

use GenerateQueueOptions.createAuto()

Creates a QueueOptions instance that automatically adjusts the interval and concurrency based on the user's allowance.

See Also:

• AutoGenerateQueueOptions

createGet

@Deprecated
public static QueueOptions createGet(ScheduledExecutorService scheduler)

Deprecated.

use GetQueueOptions.create(ScheduledExecutorService)

Creates a QueueOptions instance with default values for get requests (100ms interval, 5 concurrent requests).

createGet

@Deprecated
public static QueueOptions createGet()

Deprecated.

use GetQueueOptions.create()

Creates a QueueOptions instance with default values for get requests (100ms interval, 5 concurrent requests).

withInterval

public QueueOptions withInterval(int interval,
 TimeUnit unit)

withConcurrency

public QueueOptions withConcurrency(int concurrency)

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 the compare method from their corresponding wrapper classes.

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.

scheduler

public ScheduledExecutorService scheduler()

Returns the value of the scheduler record component.

Specified by:

scheduler in interface IQueueOptions

Returns:

the value of the scheduler record component

intervalMillis

public int intervalMillis()

Returns the value of the intervalMillis record component.

Specified by:

intervalMillis in interface IQueueOptions

Returns:

the value of the intervalMillis record component

concurrency

public int concurrency()

Returns the value of the concurrency record component.

Specified by:

concurrency in interface IQueueOptions

Returns:

the value of the concurrency record component