Package net.dv8tion.jda.api.interactions.commands

Class Command.Choice

    • Constructor Summary

      Constructors 
      Constructor Description
      Choice​(java.lang.String name, double value)
      Create a Choice tuple
      Choice​(java.lang.String name, long value)
      Create a Choice tuple
      Choice​(java.lang.String name, java.lang.String value)
      Create a Choice tuple
      Choice​(DataObject json)
      Create a Choice tuple

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      double getAsDouble()
      The value of this choice.
      long getAsLong()
      The value of this choice.
      java.lang.String getAsString()
      The value of this choice.
      java.lang.String getName()
      The readable name of this choice.
      int hashCode()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Choice

        public Choice​(@Nonnull
              java.lang.String name,
              long value)
        Create a Choice tuple
        Parameters:
        name - The display name of this choice
        value - The integer value you receive in a command option

      • Choice

        public Choice​(@Nonnull
              java.lang.String name,
              double value)
        Create a Choice tuple
        Parameters:
        name - The display name of this choice
        value - The double value you receive in a command option

      • Choice

        public Choice​(@Nonnull
              java.lang.String name,
              @Nonnull
              java.lang.String value)
        Create a Choice tuple
        Parameters:
        name - The display name of this choice
        value - The string value you receive in a command option

      • Choice

        public Choice​(@Nonnull
              DataObject json)
        Create a Choice tuple
        Parameters:
        json - The serialized choice instance with name and value mapping
        Throws:
        java.lang.IllegalArgumentException - If null is provided
        ParsingException - If the data is not formatted correctly or missing required parameters

    • Method Detail

      • getName

        @Nonnull
public java.lang.String getName()
        The readable name of this choice.
        This is shown to the user in the official client.
        Returns:
        The choice name

      • getAsDouble

        public double getAsDouble()
        The value of this choice.
        Returns:
        The double value, or NaN if this is not a numeric choice value

      • getAsLong

        public long getAsLong()
        The value of this choice.
        Returns:
        The long value

      • getAsString

        @Nonnull
public java.lang.String getAsString()
        The value of this choice.
        Returns:
        The String value

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object