Package net.dv8tion.jda.api.entities

Enum Icon.IconType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Icon.IconType>
    Enclosing class:
    Icon
    public static enum Icon.IconType
extends java.lang.Enum<Icon.IconType>
    Supported image types for the Discord API.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      GIF
      GIF
      JPEG
      JPEG
      PNG
      PNG
      UNKNOWN
      Placeholder for unsupported IconTypes
      WEBP
      WEBP

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Icon.IconType fromExtension​(java.lang.String extension)
      Resolves the provided file extension type to the equivalent IconType.
      static Icon.IconType fromMIME​(java.lang.String mime)
      Resolves the provided MIME Type to the equivalent IconType.
      java.lang.String getHeader()
      The data header for the encoding of an image.
      java.lang.String getMIME()
      The MIME Type
      static Icon.IconType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Icon.IconType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static Icon.IconType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Icon.IconType c : Icon.IconType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Icon.IconType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getMIME

        @Nonnull
public java.lang.String getMIME()
        The MIME Type
        Returns:
        The MIME Type
        See Also:
        MIME

      • getHeader

        @Nonnull
public java.lang.String getHeader()
        The data header for the encoding of an image.
        Returns:
        The data header

      • fromMIME

        @Nonnull
public static Icon.IconType fromMIME​(@Nonnull
                                     java.lang.String mime)
        Resolves the provided MIME Type to the equivalent IconType.
        If the type is not supported, UNKNOWN is returned.
        Parameters:
        mime - The MIME type
        Returns:
        The resolved IconType or UNKNOWN.

      • fromExtension

        @Nonnull
public static Icon.IconType fromExtension​(@Nonnull
                                          java.lang.String extension)
        Resolves the provided file extension type to the equivalent IconType.
        If the type is not supported, UNKNOWN is returned.
        Parameters:
        extension - The extension type
        Returns:
        The resolved IconType or UNKNOWN.