Package com.viaversion.viaversion.api.platform

Record Class ViaPlatformTask

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.platform.ViaPlatformTask
All Implemented Interfaces:
PlatformTask<Task>
public record ViaPlatformTask(Task task) extends Record implements PlatformTask<Task>
Implements PlatformTask for Via's own scheduler. If present and possible, platform schedulers should be used over this.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ViaPlatformTask(Task task)
    Creates an instance of a ViaPlatformTask record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Cancels the task.
    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.
    Task
    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

  • Constructor Details

    • ViaPlatformTask

      public ViaPlatformTask(Task task)
      Creates an instance of a ViaPlatformTask record class.
      Parameters:
      task - the value for the task record component

  • Method Details

    • cancel

      public void cancel()
      Description copied from interface: PlatformTask
      Cancels the task.
      Specified by:
      cancel in interface PlatformTask<Task>

    • 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 Task task()
      Returns the value of the task record component.
      Returns:
      the value of the task record component