Record Class AddonDependency

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.addon.AddonDependency

public record AddonDependency(@NotNull AddonId addon, @NotNull VersionRange versions, boolean optional) extends Record
A registration-time dependency. The dependent addon's callback runs after addon()'s. A required dependency must be present in a version within versions(); an optional one only orders registration when present.
  • Constructor Summary

    Constructors
    Constructor
    Description
    AddonDependency(@NotNull AddonId addon, @NotNull VersionRange versions, boolean optional)
    Creates an instance of a AddonDependency record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull AddonId
    Returns the value of the addon record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the optional record component.
    final String
    Returns a string representation of this record class.
    @NotNull VersionRange
    Returns the value of the versions record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • AddonDependency

      public AddonDependency(@NotNull @NotNull AddonId addon, @NotNull @NotNull VersionRange versions, boolean optional)
      Creates an instance of a AddonDependency record class.
      Parameters:
      addon - the value for the addon record component
      versions - the value for the versions record component
      optional - the value for the optional record component
  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • addon

      @NotNull public @NotNull AddonId addon()
      Returns the value of the addon record component.
      Returns:
      the value of the addon record component
    • versions

      @NotNull public @NotNull VersionRange versions()
      Returns the value of the versions record component.
      Returns:
      the value of the versions record component
    • optional

      public boolean optional()
      Returns the value of the optional record component.
      Returns:
      the value of the optional record component