Record Class SynchronousJFXCaller<T>

java.lang.Object
java.lang.Record
net.mcreator.ui.component.filebrowser.SynchronousJFXCaller<T>
Type Parameters:
T - the return type of the callable

public record SynchronousJFXCaller<T>(Callable<T> callable) extends Record
A utility class to execute a Callable synchronously on the JavaFX event thread.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a SynchronousJFXCaller record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    call(long startTimeout, TimeUnit startTimeoutUnit)
    Executes the Callable.
    Returns the value of the callable record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    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

    • SynchronousJFXCaller

      public SynchronousJFXCaller(Callable<T> callable)
      Creates an instance of a SynchronousJFXCaller record class.
      Parameters:
      callable - the value for the callable record component
  • Method Details

    • call

      public T call(long startTimeout, TimeUnit startTimeoutUnit) throws Exception
      Executes the Callable.

      A specialized task is run using Platform.runLater(). The calling thread then waits first for the task to start, then for it to return a result. Any exception thrown by the Callable will be rethrown in the calling thread.

      Parameters:
      startTimeout - time to wait for Platform.runLater() to start the dialog-showing task
      startTimeoutUnit - the time unit of the startTimeout argument
      Returns:
      whatever the Callable returns
      Throws:
      IllegalStateException - if Platform.runLater() fails to start the task within the given timeout
      InterruptedException - if the calling (this) thread is interrupted while waiting for the task to start or to get its result (note that the task will still run anyway and its result will be ignored)
      Exception
    • 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.
    • callable

      public Callable<T> callable()
      Returns the value of the callable record component.
      Returns:
      the value of the callable record component