Package net.neoforged.fml.loading.moddiscovery.locators

Record Class PathBasedLocator

java.lang.Object
java.lang.Record
net.neoforged.fml.loading.moddiscovery.locators.PathBasedLocator
All Implemented Interfaces:
IModFileCandidateLocator, IOrderedProvider
public record PathBasedLocator(String name, List<Path> paths) extends Record implements IModFileCandidateLocator
"Locates" mods from a fixed set of paths.

  • Field Details

    • name

      private final String name
      The field for the name record component.

    • paths

      private final List<Path> paths
      The field for the paths record component.

  • Constructor Details

    • PathBasedLocator

      public PathBasedLocator(String name, Path... paths)

    • PathBasedLocator

      public PathBasedLocator(String name, List<Path> paths)
      Creates an instance of a PathBasedLocator record class.
      Parameters:
      name - the value for the name record component
      paths - the value for the paths record component

  • Method Details

    • findCandidates

      public void findCandidates(ILaunchContext context, IDiscoveryPipeline pipeline)
      Description copied from interface: IModFileCandidateLocator
      Discovers potential mods to be loaded by FML.
      Specified by:
      findCandidates in interface IModFileCandidateLocator
      Parameters:
      pipeline - Adds discovered mods and issues to this pipeline.

    • getPriority

      public int getPriority()
      Description copied from interface: IOrderedProvider
      Gets the priority in which this provider will be called. A higher value means the provider will be called earlier.
      Specified by:
      getPriority in interface IOrderedProvider

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

    • name

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

    • paths

      public List<Path> paths()
      Returns the value of the paths record component.
      Returns:
      the value of the paths record component