Abstract Job
- Parameters
The name of the job
The expression to use when scheduling
diff --git a/README.md b/README.md index d42fabd..5eaa11d 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ I built this library as a personal usage library to handling schedulers within the applications I am creating, and it'll be easier if I put it in a library that I can reuse. +I currently use **Haru** with my private Discord bot, Noel. + ## Usage ```kotlin class MyJob: AbstractJob( @@ -44,7 +46,7 @@ I'd say around ~3 hours :) ## Installation > Documentation: https://haru.floofy.dev > -> Version: 1.2.0 +> Version: 1.3.0 ## Gradle ### Kotlin DSL diff --git a/build.gradle.kts b/build.gradle.kts index ae54de8..5e085a7 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -25,13 +25,13 @@ import java.util.Properties import java.util.Date plugins { - id("com.diffplug.spotless") version "5.14.0" + id("com.diffplug.spotless") version "6.0.0" id("org.jetbrains.dokka") version "1.5.31" - kotlin("jvm") version "1.5.10" + kotlin("jvm") version "1.5.31" `maven-publish` } -val current = "1.2.0" +val current = "1.3.0" group = "dev.floofy" version = current @@ -42,9 +42,9 @@ repositories { dependencies { // Kotlin libraries - implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2") - api("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:1.5.2") - implementation(kotlin("stdlib", "1.5.21")) + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2-native-mt") + api("org.jetbrains.kotlinx:kotlinx-coroutines-reactor:1.5.2-native-mt") + implementation(kotlin("stdlib", "1.5.31")) // Cron Support implementation("com.cronutils:cron-utils:9.1.5") diff --git a/docs/-haru/dev.floofy.haru.abstractions/-abstract-job/-abstract-job.html b/docs/-haru/dev.floofy.haru.abstractions/-abstract-job/-abstract-job.html index 15b54a7..a5d8207 100644 --- a/docs/-haru/dev.floofy.haru.abstractions/-abstract-job/-abstract-job.html +++ b/docs/-haru/dev.floofy.haru.abstractions/-abstract-job/-abstract-job.html @@ -1,49 +1,49 @@ - -
- -The name of the job
The expression to use when scheduling
The name of the job
The expression to use when scheduling
Represents the coroutine job for this AbstractJob, returns null
if it hasn't been scheduled.
Represents the coroutine job for this AbstractJob, returns null
if it hasn't been scheduled.
Executes this AbstractJob in a separate thread-pool.
Executes this AbstractJob in a separate thread-pool.
Returns the execution time for this job, returns null
if it hasn't been scheduled.
Returns the execution time for this job, returns null
if it hasn't been scheduled.
The expression to use when scheduling
Updates the next delay and returns when the next delay is
Updates the next delay and returns when the next delay is
Represents an abstraction for constructing jobs. This is the Java-style of way to create a Job without using the DSL if you wish.
The name of the job
The expression to use when scheduling
Represents an abstraction for constructing jobs. This is the Java-style of way to create a Job without using the DSL if you wish.
The name of the job
The expression to use when scheduling
Executes this AbstractJob in a separate thread-pool.
Updates the next delay and returns when the next delay is
Represents the coroutine job for this AbstractJob, returns null
if it hasn't been scheduled.
Returns the next delay in milliseconds, returns null
if it hasn't been scheduled.
Returns the next delay in milliseconds, returns null
if it hasn't been scheduled.
Represents an abstraction for constructing jobs. This is the Java-style of way to create a Job without using the DSL if you wish.
Converts a ScheduleBuilder instance to an abstract-able job.
Converts a ScheduleBuilder instance to an abstractable job.
Converts a ScheduleBuilder instance to an abstract-able job.
Returns the executor to execute this scheduler.
Returns the executor to execute this scheduler.
The expression to use when scheduling this job. This supports full Unix CRON expressions like @hourly
!
The expression to use when scheduling this job. This supports full Unix CRON expressions like @hourly
!
Represents a builder class to construct AbstractJobs.
Represents a builder class to construct AbstractJobs.
Converts a ScheduleBuilder instance to an abstract-able job.
If the job should be started automatically or not.
If the job should be started automatically or not.
Represents a builder class to construct AbstractJobs.
Represents a exception of when there is no AbstractJob registers in the current Scheduler
Represents a exception of when there is no AbstractJob registers in the current Scheduler
Represents a exception of when there is no AbstractJob registers in the current Scheduler
Returns a date on when the library was built at.
Returns a date on when the library was built at.
Represents the versioning information.
Represents the versioning information.
Creates a new Scheduler as a DSL function with the block being a Scheduler.Options initializer.
This Scheduler object.
The block to create this Scheduler.
Creates a new Scheduler as a DSL function with the block being a Scheduler.Options initializer.
This Scheduler object.
The block to create this Scheduler.
Returns a error handler for all scheduled jobs if that specific job doesn't have a jobOnError
executor.
Returns an error handler for all scheduled jobs if that specific job doesn't have a jobOnError
executor.
Attaches a handler to the current errorHandler in this embedded Options context.
The handler function to call
Attaches a handler to the current errorHandler in this embedded Options context.
The handler function to call
Any additional options to extend this Scheduler
Any additional options to extend this Scheduler
Attaches a handler to the current errorHandler in this embedded Options context.
Appends all jobs specified into the Scheduler tree.
This Scheduler instance.
The jobs to schedule
If the jobs should be started.
Represents a Scheduler class to handle scheduling within this project.
Any additional options or it'll use the default options
Represents a Scheduler class to handle scheduling within this project.
Any additional options or it'll use the default options
Schedules the job by a builder.
Schedules the job and if start is true, starts it otherwise, it'll have to be started programmatically using Scheduler#start(AbstractJob).
Unschedules all jobs in this scheduler.
Unschedule and cancels the coroutine job attached to the AbstractJob, if it was scheduled.
Schedules the job and if start is true, starts it otherwise, it'll have to be started programmatically using Scheduler#start(AbstractJob).
The job to use
Schedules the job and if start is true, starts it otherwise, it'll have to be started programmatically using Scheduler#start(AbstractJob).
The job to use
Unschedule and cancels the coroutine job attached to the AbstractJob, if it was scheduled.
The name of the job
Unschedules all jobs in this scheduler.
Unschedule and cancels the coroutine job attached to the AbstractJob, if it was scheduled.
The name of the job
Unschedules all jobs in this scheduler.
Creates a new Scheduler as a DSL function with the block being a Scheduler.Options initializer.