Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- attempt() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns the value of the
attemptrecord component. - attempt() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
attemptrecord component.
C
- cancel() - Method in interface com.cotani.job.api.JobHandle
-
Requests local cancellation without waiting for durable removal.
- cancelAsync(JobId) - Method in interface com.cotani.job.api.JobService
-
Cancels a job and removes its durable recovery record when possible.
- cancelled() - Method in interface com.cotani.job.api.JobHandle
- cause() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
causerecord component. - close() - Method in interface com.cotani.job.api.JobService
-
Starts asynchronous close.
- closeAsync() - Method in interface com.cotani.job.api.JobService
-
Stops new scheduling and cancels local timers.
- com.cotani.job - package com.cotani.job
- com.cotani.job.api - package com.cotani.job.api
- CotaniJobs - Class in com.cotani.job
-
Factories for the
cotani-jobmodule. - create(PaperTaskScheduler, PersistentTaskStore) - Static method in class com.cotani.job.CotaniJobs
-
Creates a service backed by the caller-owned persistent task store.
- create(PaperTaskScheduler, PersistentTaskStore, JobServiceOptions) - Static method in class com.cotani.job.CotaniJobs
-
Creates a service with explicit runtime policies and persistence.
D
- DEFAULT_MAX_RECOVERY_BATCH - Static variable in record class com.cotani.job.api.JobServiceOptions
- defaults() - Static method in record class com.cotani.job.api.JobRetryPolicy
- defaults() - Static method in record class com.cotani.job.api.JobServiceOptions
- delay() - Method in record class com.cotani.job.api.JobSchedule.Once
-
Returns the value of the
delayrecord component. - delayBeforeNextAttempt(int) - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns the delay before the next attempt after
completedAttempt.
E
- equals(Object) - Method in record class com.cotani.job.api.JobExecutionContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobExecutionId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobFailure
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobRetryPolicy
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobSchedule.Once
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobSchedule.Recurring
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.cotani.job.api.JobServiceOptions
-
Indicates whether some other object is "equal to" this one.
- executeAsync(JobExecutionContext) - Method in interface com.cotani.job.api.JobHandler
- executionId() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns the value of the
executionIdrecord component.
F
- failureListener() - Method in record class com.cotani.job.api.JobServiceOptions
-
Returns the value of the
failureListenerrecord component.
H
- handlerName() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns the value of the
handlerNamerecord component. - handlerName() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
handlerNamerecord component. - handlerName() - Method in exception class com.cotani.job.api.JobHandlerNotFoundException
- handlerName() - Method in record class com.cotani.job.api.JobRequest
-
Returns the value of the
handlerNamerecord component. - handlerTimeout() - Method in record class com.cotani.job.api.JobServiceOptions
-
Returns the value of the
handlerTimeoutrecord component. - hashCode() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobExecutionId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobFailure
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobSchedule.Once
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobSchedule.Recurring
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.cotani.job.api.JobServiceOptions
-
Returns a hash code value for this object.
I
- id() - Method in interface com.cotani.job.api.JobHandle
- initialBackoff() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns the value of the
initialBackoffrecord component. - initialDelay() - Method in record class com.cotani.job.api.JobSchedule.Recurring
-
Returns the value of the
initialDelayrecord component. - inMemory(PaperTaskScheduler) - Static method in class com.cotani.job.CotaniJobs
-
Creates a non-durable service intended for tests and ephemeral jobs.
- interval() - Method in record class com.cotani.job.api.JobSchedule.Recurring
-
Returns the value of the
intervalrecord component.
J
- JobExecutionContext - Record Class in com.cotani.job.api
-
Immutable context supplied to a handler for one attempt.
- JobExecutionContext(JobId, JobExecutionId, String, int, byte[]) - Constructor for record class com.cotani.job.api.JobExecutionContext
-
Creates an instance of a
JobExecutionContextrecord class. - JobExecutionContext(JobId, String, int, byte[]) - Constructor for record class com.cotani.job.api.JobExecutionContext
-
Compatibility constructor for manually created contexts.
- JobExecutionId - Record Class in com.cotani.job.api
-
Identifies one occurrence of a logical job, including all of its retries.
- JobExecutionId(UUID) - Constructor for record class com.cotani.job.api.JobExecutionId
-
Creates an instance of a
JobExecutionIdrecord class. - JobFailure - Record Class in com.cotani.job.api
-
Describes a failed attempt reported to the configured failure listener.
- JobFailure(JobId, String, int, int, boolean, Throwable) - Constructor for record class com.cotani.job.api.JobFailure
-
Creates an instance of a
JobFailurerecord class. - JobFailureListener - Interface in com.cotani.job.api
-
Receives failed attempts without changing the job outcome.
- JobHandle - Interface in com.cotani.job.api
-
Controls one logical job without exposing scheduler implementation details.
- JobHandler - Interface in com.cotani.job.api
-
Asynchronous, Bukkit-free implementation of a named job.
- JobHandlerNotFoundException - Exception Class in com.cotani.job.api
-
Raised when a job references a handler that has not been registered.
- JobHandlerNotFoundException(String) - Constructor for exception class com.cotani.job.api.JobHandlerNotFoundException
- jobId() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns the value of the
jobIdrecord component. - jobId() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
jobIdrecord component. - JobId - Record Class in com.cotani.job.api
-
Stable identifier shared by all attempts of one logical job.
- JobId(UUID) - Constructor for record class com.cotani.job.api.JobId
-
Creates an instance of a
JobIdrecord class. - JobRequest - Record Class in com.cotani.job.api
-
Immutable definition used to schedule one logical job.
- JobRequest(String, byte[], JobSchedule, JobRetryPolicy) - Constructor for record class com.cotani.job.api.JobRequest
-
Creates an instance of a
JobRequestrecord class. - JobRetryPolicy - Record Class in com.cotani.job.api
-
Bounded exponential backoff policy for failed job attempts.
- JobRetryPolicy(int, Duration, Duration, double) - Constructor for record class com.cotani.job.api.JobRetryPolicy
-
Creates an instance of a
JobRetryPolicyrecord class. - JobSchedule - Interface in com.cotani.job.api
-
Defines whether a job runs once or repeats after each successful execution.
- JobSchedule.Once - Record Class in com.cotani.job.api
-
Runs the job once after
delay. - JobSchedule.Recurring - Record Class in com.cotani.job.api
-
Repeats the job after every successful execution.
- JobService - Interface in com.cotani.job.api
-
Non-blocking service for durable, named asynchronous jobs.
- JobServiceOptions - Record Class in com.cotani.job.api
-
Runtime policies applied to every job handler invocation.
- JobServiceOptions(Duration, JobFailureListener) - Constructor for record class com.cotani.job.api.JobServiceOptions
- JobServiceOptions(Duration, JobFailureListener, int) - Constructor for record class com.cotani.job.api.JobServiceOptions
-
Creates an instance of a
JobServiceOptionsrecord class.
M
- MAX_HANDLER_NAME_LENGTH - Static variable in record class com.cotani.job.api.JobRequest
- MAX_RECOVERY_BATCH - Static variable in record class com.cotani.job.api.JobServiceOptions
- maxAttempts() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
maxAttemptsrecord component. - maxAttempts() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns the value of the
maxAttemptsrecord component. - maximumBackoff() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns the value of the
maximumBackoffrecord component. - maxRecoveryBatch() - Method in record class com.cotani.job.api.JobServiceOptions
-
Returns the value of the
maxRecoveryBatchrecord component. - multiplier() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns the value of the
multiplierrecord component.
O
- once(String, byte[], Duration) - Static method in record class com.cotani.job.api.JobRequest
- Once(Duration) - Constructor for record class com.cotani.job.api.JobSchedule.Once
-
Creates an instance of a
Oncerecord class. - onFailure(JobFailure) - Method in interface com.cotani.job.api.JobFailureListener
P
- payload() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns the value of the
payloadrecord component. - payload() - Method in record class com.cotani.job.api.JobRequest
-
Returns the value of the
payloadrecord component.
R
- random() - Static method in record class com.cotani.job.api.JobExecutionId
- random() - Static method in record class com.cotani.job.api.JobId
- recoverPendingAsync() - Method in interface com.cotani.job.api.JobService
-
Loads and dispatches up to
JobServiceOptions.maxRecoveryBatch()pending Cotani job records with registered handlers. - recurring(String, byte[], Duration, Duration) - Static method in record class com.cotani.job.api.JobRequest
- Recurring(Duration, Duration) - Constructor for record class com.cotani.job.api.JobSchedule.Recurring
-
Creates an instance of a
Recurringrecord class. - registerHandler(String, JobHandler) - Method in interface com.cotani.job.api.JobService
-
Registers or replaces a handler before scheduling or recovering jobs.
- retryPolicy() - Method in record class com.cotani.job.api.JobRequest
-
Returns the value of the
retryPolicyrecord component.
S
- schedule() - Method in record class com.cotani.job.api.JobRequest
-
Returns the value of the
schedulerecord component. - scheduleAsync(JobRequest) - Method in interface com.cotani.job.api.JobService
-
Schedules a job and durably writes its recovery record before dispatch.
T
- toString() - Method in record class com.cotani.job.api.JobExecutionContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobExecutionId
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobFailure
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobId
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobRequest
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobRetryPolicy
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobSchedule.Once
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobSchedule.Recurring
-
Returns a string representation of this record class.
- toString() - Method in record class com.cotani.job.api.JobServiceOptions
-
Returns a string representation of this record class.
V
- value() - Method in record class com.cotani.job.api.JobExecutionId
-
Returns the value of the
valuerecord component. - value() - Method in record class com.cotani.job.api.JobId
-
Returns the value of the
valuerecord component.
W
- willRetry() - Method in record class com.cotani.job.api.JobFailure
-
Returns the value of the
willRetryrecord component. - withFailureListener(JobFailureListener) - Method in record class com.cotani.job.api.JobServiceOptions
- withHandlerTimeout(Duration) - Method in record class com.cotani.job.api.JobServiceOptions
- withMaxRecoveryBatch(int) - Method in record class com.cotani.job.api.JobServiceOptions
- withRetryPolicy(JobRetryPolicy) - Method in record class com.cotani.job.api.JobRequest
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form