Module org.jpo
Package org.jpo.eventbus

Record Class FileLoadRequest

java.lang.Object
java.lang.Record
org.jpo.eventbus.FileLoadRequest
Record Components:
fileToLoad - the file to load
public record FileLoadRequest(@NotNull File fileToLoad) extends Record
This request indicates that a file is to be loaded and shown

It will not check for unsaved updates. To check for those wrap this in a UnsavedUpdatesDialogRequest:

JpoEventBus.getInstance().post( new UnsavedUpdatesDialogRequest( new FileLoadRequest()) );

  • Constructor Summary

    Constructors
    Constructor
    Description
    FileLoadRequest(@NotNull File fileToLoad)
    Constructor validates that the file exists, is readable and is not a directory.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull File
    fileToLoad()
    Returns the value of the fileToLoad record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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

    • FileLoadRequest

      public FileLoadRequest(@NotNull @NotNull File fileToLoad)
      Constructor validates that the file exists, is readable and is not a directory.
      Parameters:
      fileToLoad - the file to load

  • Method Details

    • 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.

    • fileToLoad

      @NotNull public @NotNull File fileToLoad()
      Returns the value of the fileToLoad record component.
      Returns:
      the value of the fileToLoad record component