Package dev.sympho.modular_commands.execute

Record Class Metrics.Tag.Channel

java.lang.Object

java.lang.Record

dev.sympho.modular_commands.execute.Metrics.Tag.Channel

Record Components:

id - The channel ID.

All Implemented Interfaces:

Metrics.Tag

Enclosing interface:

Metrics.Tag

public static record Metrics.Tag.Channel(Snowflake id)
extends Record
implements Metrics.Tag

The tag that indicates the channel that the command was called from.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.execute.Metrics.Tag

Metrics.Tag.Caller, Metrics.Tag.Channel, Metrics.Tag.CommandId, Metrics.Tag.CommandInvocation, Metrics.Tag.Guild, Metrics.Tag.Type

Constructor Summary

Constructors

Constructor	Description
Channel(Snowflake id)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static Metrics.Tag.Channel	from(Snowflake id)	Creates a tag with the given id as value.
final int	hashCode()	Returns a hash code value for this object.
Snowflake	id()	Returns the value of the id record component.
String	key()	Retrieves the tag key.
final String	toString()	Returns a string representation of this record class.
String	value()	Retrieves the tag value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.sympho.modular_commands.execute.Metrics.Tag

apply, apply

Constructor Details

Channel

public Channel(Snowflake id)

Creates a new instance.

Parameters:

id - The channel ID.

Method Details

from

public static Metrics.Tag.Channel from(Snowflake id)

Creates a tag with the given id as value.

Parameters:

id - The ID of the 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 Snowflake id()

Returns the value of the id record component.

Returns:

the value of the id record component