Record Class PackPath

java.lang.Object
java.lang.Record
kr.toxicity.model.api.pack.PackPath
Record Components:
path - the string representation of the path
All Implemented Interfaces:
Comparable<PackPath>
public record PackPath(@NotNull String path) extends Record implements Comparable<PackPath>
Represents a path within a resource pack.

This record encapsulates a string path and provides utility methods for resolving sub-paths. It implements Comparable for sorting purposes.

Since:
1.15.2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DELIMITER
    The delimiter used for path separation.
    static final PackPath
    EMPTY
    An empty pack path.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PackPath(@NotNull String path)
    Creates an instance of a PackPath record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(@NotNull PackPath o)
     
    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.
    @NotNull String
    path()
    Returns the value of the path record component.
    @NotNull PackPath
    resolve(@NotNull String... subPaths)
    Resolves a sub-path relative to this path.
    @NotNull String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • DELIMITER

      public static final String DELIMITER
      The delimiter used for path separation.
      Since:
      1.15.2
      See Also:

    • EMPTY

      public static final PackPath EMPTY
      An empty pack path.
      Since:
      1.15.2

  • Constructor Details

    • PackPath

      public PackPath(@NotNull @NotNull String path)
      Creates an instance of a PackPath record class.
      Parameters:
      path - the value for the path record component

  • Method Details

    • resolve

      @NotNull public @NotNull PackPath resolve(@NotNull @NotNull String... subPaths)
      Resolves a sub-path relative to this path.
      Parameters:
      subPaths - the sub-path components to resolve
      Returns:
      the resolved pack path
      Since:
      1.15.2

    • toString

      @NotNull public @NotNull 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

    • compareTo

      public int compareTo(@NotNull @NotNull PackPath o)
      Specified by:
      compareTo in interface Comparable<PackPath>

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

    • path

      @NotNull public @NotNull String path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component