Package dev.sympho.modular_commands.execute

Record Class StaticPrefix

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.execute.StaticPrefix
Record Components:
prefix - The prefix to use.
All Implemented Interfaces:
PrefixProvider
public record StaticPrefix(String prefix) extends Record implements PrefixProvider
Prefix provider that only uses a static prefix determined at construction time.
Since:
1.0
Version:
1.0

  • Constructor Details

    • StaticPrefix

      public StaticPrefix(String prefix)
      Creates an instance of a StaticPrefix record class.
      Parameters:
      prefix - the value for the prefix record component

  • Method Details

    • getPrefix

      public String getPrefix(@Nullable Snowflake guildId)
      Description copied from interface: PrefixProvider
      Determines the prefix that should be used for the given guild.
      Specified by:
      getPrefix in interface PrefixProvider
      Parameters:
      guildId - The ID of the guild that the event was issued from, or null if it was issued from a private channel.
      Returns:
      The prefix to use.

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

    • prefix

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