Package dev.sympho.modular_commands.execute

Record Class Metrics.Tag.CommandInvocation

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.execute.Metrics.Tag.CommandInvocation
Record Components:
invocation - The invocation.
canonical - true if the invocation is the canonical one (with aliases resolved). false if the invocation is the one called by user (may have aliases).
All Implemented Interfaces:
Metrics.Tag
Enclosing interface:
Metrics.Tag
public static record Metrics.Tag.CommandInvocation(Invocation invocation, boolean canonical) extends Record implements Metrics.Tag
The tag that indicates the command invocation.
Since:
1.0

  • Field Details

  • Constructor Details

    • CommandInvocation

      public CommandInvocation(Invocation invocation, boolean canonical)
      Creates a new instance.
      Parameters:
      invocation - The invocation.
      canonical - true if the invocation is the canonical one (with aliases resolved). false if the invocation is the one called by user (may have aliases).

  • Method Details

    • called

      public static Metrics.Tag.CommandInvocation called(Invocation invocation)
      Creates a tag with the given called invocation as value.
      Parameters:
      invocation - The invocation.
      Returns:
      The created tag.

    • canonical

      public static Metrics.Tag.CommandInvocation canonical(Invocation invocation)
      Creates a tag with the given canonical invocation as value.
      Parameters:
      invocation - The invocation.
      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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • invocation

      public Invocation invocation()
      Returns the value of the invocation record component.
      Returns:
      the value of the invocation record component

    • canonical

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