Package net.dv8tion.jda.api.entities
Class Icon
- java.lang.Object
-
- net.dv8tion.jda.api.entities.Icon
-
public class Icon extends 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 Iconfrom(byte[] data)Creates anIconwith the specified image data.static Iconfrom(File file)static Iconfrom(InputStream stream)Creates anIconwith the specifiedInputStream.StringgetEncoding()The base64 encoded data for this Icon
-
-
-
Method Detail
-
getEncoding
@Nonnull public String getEncoding()
The base64 encoded data for this Icon- Returns:
- String representation of the encoded data for this icon
-
from
@Nonnull public static Icon from(@Nonnull File file) throws IOException
Creates anIconwith the specifiedFile.
We here read the specified File and forward the retrieved byte data tofrom(byte[]).- Parameters:
file- An existing, not-null file.- Returns:
- An Icon instance representing the specified File
- Throws:
IllegalArgumentException- if the provided file is either null or does not existIOException- if there is a problem while reading the file.- See Also:
IOUtil.readFully(File)
-
from
@Nonnull public static Icon from(@Nonnull InputStream stream) throws IOException
Creates anIconwith the specifiedInputStream.
We here read the specified InputStream and forward the retrieved byte data tofrom(byte[]).- Parameters:
stream- A not-null InputStream.- Returns:
- An Icon instance representing the specified InputStream
- Throws:
IllegalArgumentException- if the provided stream is nullIOException- 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
@Nonnull public static Icon from(@Nonnull byte[] data)
Creates anIconwith the specified image data.- Parameters:
data- not-null image data bytes.- Returns:
- An Icon instance representing the specified image data
- Throws:
IllegalArgumentException- if the provided data is null
-
-