Package dev.sympho.modular_commands.execute

Record Class Metrics.Tag.Guild

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.execute.Metrics.Tag.Guild
Record Components:
id - The guild ID, or null if called from a private channel.
All Implemented Interfaces:
Metrics.Tag
Enclosing interface:
Metrics.Tag
public static record Metrics.Tag.Guild(@Nullable Snowflake id) extends Record implements Metrics.Tag
The tag that indicates the guild that the command was called from, if any.
Since:
1.0

  • Field Details

    • DM_VALUE

      public static final String DM_VALUE
      The tag value for a direct message.
      See Also:

    • DM

      public static final Metrics.Tag.Guild DM
      The tag for a direct message (where there is no guild). In this case, the value of the tag is "none".

  • Constructor Details

    • Guild

      public Guild(@Nullable Snowflake id)
      Creates an instance of a Guild record class.
      Parameters:
      id - the value for the id record component

  • Method Details

    • from

      public static Metrics.Tag.Guild from(@Nullable Snowflake id)
      Creates a tag with the given id as value.
      Parameters:
      id - The ID of the guild. May be null for a private channel.
      Returns:
      The created tag.

    • from

      public static Metrics.Tag.Guild from(Optional<Snowflake> id)
      Creates a tag with the given id as value.
      Parameters:
      id - The ID of the guild. May be empty for a private channel.
      Returns:
      The created tag.

    • key

      public String key()
      Description copied from interface: Metrics.Tag
      Retrieves the tag key.
      Specified by:
      key in interface Metrics.Tag
      Returns:
      The tag key.

    • value

      public String value()
      Description copied from interface: Metrics.Tag
      Retrieves the tag value.
      Specified by:
      value in interface Metrics.Tag
      Returns:
      The tag value.

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

    • id

      public @Nullable Snowflake id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component