Package limn.backend

Record Class FileDialogs.Filter

java.lang.Object
java.lang.Record
limn.backend.FileDialogs.Filter
Enclosing interface:
FileDialogs
public static record FileDialogs.Filter(String description, List<String> patterns) extends Record
A file-name filter: a human-readable description plus glob patterns, e.g. Filter.of("Images", "*.png", "*.jpg"). Dialogs may show the description and restrict the listing to the patterns. Open dialogs honour the patterns on macOS too, including *.ext filters for extensions no installed application registers (an application's own document type): the macOS panel matches by uniform type identifier, not filename, and the backend translates such patterns to the system's identifier. The macOS save panel offers no name filtering: a filter passed to FileDialogs.saveFile(java.lang.String, java.nio.file.Path, limn.backend.FileDialogs.Filter) is ignored there; the other platforms filter save dialogs by name as usual.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Filter(String description, List<String> patterns)
    Creates an instance of a Filter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Returns the value of the description record component.
    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.
    static FileDialogs.Filter
    of(String description, String... patterns)
    A filter shown as description, matching glob patterns like "*.png".
    List<String>
    patterns()
    Returns the value of the patterns 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

    • Filter

      public Filter(String description, List<String> patterns)
      Creates an instance of a Filter record class.
      Parameters:
      description - the value for the description record component
      patterns - the value for the patterns record component

  • Method Details

    • of

      public static FileDialogs.Filter of(String description, String... patterns)
      A filter shown as description, matching glob patterns like "*.png".

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

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • patterns

      public List<String> patterns()
      Returns the value of the patterns record component.
      Returns:
      the value of the patterns record component