Package dev.mintychochip.mint

Record Class Plugin

java.lang.Object
java.lang.Record
dev.mintychochip.mint.Plugin
Record Components:
displayName - the display name of the plugin
namespace - the unique namespace identifier for the plugin
@AvailableSince("1.0") public record Plugin(@NotNull net.kyori.adventure.text.Component displayName, @NotNull String namespace) extends Record
Represents a plugin that can own preferences and themes.
Since:
1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Plugin(@NotNull net.kyori.adventure.text.Component displayName, @NotNull String namespace)
    Creates an instance of a Plugin record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull net.kyori.adventure.text.Component
    displayName()
    Returns the value of the displayName record component.
    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
    namespace()
    Returns the value of the namespace record component.
    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

    • Plugin

      public Plugin(@NotNull @NotNull net.kyori.adventure.text.Component displayName, @NotNull @NotNull String namespace)
      Creates an instance of a Plugin record class.
      Parameters:
      displayName - the value for the displayName record component
      namespace - the value for the namespace 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. 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.

    • displayName

      @NotNull public @NotNull net.kyori.adventure.text.Component displayName()
      Returns the value of the displayName record component.
      Returns:
      the value of the displayName record component

    • namespace

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