Record Class AddonId

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.addon.AddonId
All Implemented Interfaces:
Comparable<AddonId>
public record AddonId(@NotNull String name) extends Record implements Comparable<AddonId>
Identifies an addon (normally the name of the plugin that registers content). Every registration, listener and diagnostic is attributed to one.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final AddonId
    MACHINE_ENGINE
    MachineEngine itself; reserved.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(@NotNull AddonId other)
     
    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
    name()
    Returns the value of the name record component.
    @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

    • MACHINE_ENGINE

      public static final AddonId MACHINE_ENGINE
      MachineEngine itself; reserved.

  • Constructor Details

    • AddonId

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

  • Method Details

    • compareTo

      public int compareTo(@NotNull @NotNull AddonId other)
      Specified by:
      compareTo in interface Comparable<AddonId>

    • 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

    • 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

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