Class Icon


  • public class Icon
    extends java.lang.Object
    Icon containing a base64 encoded jpeg/png/gif/gifv image.
    Used to represent various base64 images in the Discord api.
    Example: AccountManager.setAvatar(Icon).
    Since:
    3.0
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Icon from​(byte[] data)
      Creates an Icon with the specified image data.
      static Icon from​(java.io.File file)
      Creates an Icon with the specified File.
      static Icon from​(java.io.InputStream stream)
      Creates an Icon with the specified InputStream.
      java.lang.String getEncoding()
      The base64 encoded data for this Icon
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getEncoding

        public java.lang.String getEncoding()
        The base64 encoded data for this Icon
        Returns:
        String representation of the encoded data for this icon
      • from

        public static Icon from​(java.io.File file)
                         throws java.io.IOException
        Creates an Icon with the specified File.
        We here read the specified File and forward the retrieved byte data to from(byte[]).
        Parameters:
        file - An existing, not-null file.
        Returns:
        An Icon instance representing the specified File
        Throws:
        java.lang.IllegalArgumentException - if the provided file is either null or does not exist
        java.io.IOException - if there is a problem while reading the file.
        See Also:
        IOUtil.readFully(File)
      • from

        public static Icon from​(java.io.InputStream stream)
                         throws java.io.IOException
        Creates an Icon with the specified InputStream.
        We here read the specified InputStream and forward the retrieved byte data to from(byte[]).
        Parameters:
        stream - A not-null InputStream.
        Returns:
        An Icon instance representing the specified InputStream
        Throws:
        java.lang.IllegalArgumentException - if the provided stream is null
        java.io.IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.
        See Also:
        IOUtil.readFully(InputStream)
      • from

        public static Icon from​(byte[] data)
        Creates an Icon with the specified image data.
        Parameters:
        data - not-null image data bytes.
        Returns:
        An Icon instance representing the specified image data
        Throws:
        java.lang.IllegalArgumentException - if the provided data is null