Package ffx.utilities

Record Class FilePathInfo

java.lang.Object
java.lang.Record
ffx.utilities.FilePathInfo
public record FilePathInfo(String directory, String baseName, String extension) extends Record
A simple record to hold file path information.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FilePathInfo(String directory, String baseName, String extension)
    Creates an instance of a FilePathInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    baseName()
    Returns the value of the baseName record component.
    String
    directory()
    Returns the value of the directory record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    extension()
    Returns the value of the extension record component.
    static FilePathInfo
    fromFile(File file)
    Create a FilePathInfo from a File object.
    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

    • FilePathInfo

      public FilePathInfo(String directory, String baseName, String extension)
      Creates an instance of a FilePathInfo record class.
      Parameters:
      directory - the value for the directory record component
      baseName - the value for the baseName record component
      extension - the value for the extension record component

  • Method Details

    • fromFile

      public static FilePathInfo fromFile(File file)
      Create a FilePathInfo from a File object.
      Parameters:
      file - the File object
      Returns:
      a FilePathInfo instance

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

    • directory

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

    • baseName

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

    • extension

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