Package dev.sympho.modular_commands.utils.parse.entity

Record Class EntityRef.ChannelRef<C extends @NonNull Channel>

java.lang.Object
java.lang.Record
dev.sympho.modular_commands.utils.parse.entity.EntityRef.ChannelRef<C>
Type Parameters:
C - The channel type.
Record Components:
type - The channel type.
id - The channel ID.
All Implemented Interfaces:
EntityRef<C>
Enclosing interface:
EntityRef<E extends @NonNull Entity>
public static record EntityRef.ChannelRef<C extends @NonNull Channel>(Class<C extends @NonNull Channel> type, Snowflake id) extends Record implements EntityRef<C>
A reference to a channel.
Since:
1.0

  • Constructor Details

    • ChannelRef

      public ChannelRef(Class<C> type, Snowflake id)
      Creates an instance of a ChannelRef record class.
      Parameters:
      type - the value for the type record component
      id - the value for the id record component

  • Method Details

    • get

      public Mono<C> get(GatewayDiscordClient client)
      Description copied from interface: EntityRef
      Obtains the referenced entity.
      Specified by:
      get in interface EntityRef<C extends @NonNull Channel>
      Parameters:
      client - The client to use to connect to Discord.
      Returns:
      The entity. May be empty if there is no entity that matches the reference, and may fail with a InvalidArgumentException if an entity exists but there is a mismatch.

    • toString

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

    • type

      public Class<C> type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • id

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