Package io.github.simplexdevelopment.scheduler

Record Class BukkitDisposable

java.lang.Object
java.lang.Record
io.github.simplexdevelopment.scheduler.BukkitDisposable
All Implemented Interfaces:
reactor.core.Disposable
public record BukkitDisposable(org.bukkit.scheduler.BukkitTask task) extends Record implements reactor.core.Disposable
An abstraction of the BukkitTask class which allows this object to be used with Reactor.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface reactor.core.Disposable

    reactor.core.Disposable.Composite, reactor.core.Disposable.Swap

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final org.bukkit.scheduler.BukkitTask
    task
    The field for the task record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BukkitDisposable(org.bukkit.scheduler.BukkitTask task)
    Creates an instance of a BukkitDisposable record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Disposes of the task upstream on the Bukkit scheduler.
    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.
    boolean
    isDisposed()
    Checks if the task is cancelled.
    org.bukkit.scheduler.BukkitTask
    task()
    Returns the value of the task 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

  • Field Details

    • task

      private final org.bukkit.scheduler.BukkitTask task
      The field for the task record component.

  • Constructor Details

    • BukkitDisposable

      public BukkitDisposable(org.bukkit.scheduler.BukkitTask task)
      Creates an instance of a BukkitDisposable record class.
      Parameters:
      task - the value for the task record component

  • Method Details

    • dispose

      public void dispose()
      Disposes of the task upstream on the Bukkit scheduler.
      Specified by:
      dispose in interface reactor.core.Disposable

    • isDisposed

      public boolean isDisposed()
      Checks if the task is cancelled.
      Specified by:
      isDisposed in interface reactor.core.Disposable
      Returns:
      true if the task is cancelled, false otherwise.

    • 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 Objects::equals(Object,Object).
      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.

    • task

      public org.bukkit.scheduler.BukkitTask task()
      Returns the value of the task record component.
      Returns:
      the value of the task record component