Package net.dv8tion.jda.api.entities
Class Icon
- java.lang.Object
-
- net.dv8tion.jda.api.entities.Icon
-
public class Icon extends java.lang.ObjectIcon 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
- See Also:
from(File),from(byte[]),from(InputStream),from(File, IconType),from(byte[], IconType),from(InputStream, IconType)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classIcon.IconTypeSupported image types for the Discord API.
-
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(byte[] data, Icon.IconType type)Creates anIconwith the specified image data.static Iconfrom(java.io.File file)Creates anIconwith the specifiedFile.static Iconfrom(java.io.File file, Icon.IconType type)Creates anIconwith the specifiedFile.static Iconfrom(java.io.InputStream stream)Creates anIconwith the specifiedInputStream.static Iconfrom(java.io.InputStream stream, Icon.IconType type)Creates anIconwith the specifiedInputStream.java.lang.StringgetEncoding()The base64 encoded data for this Icon
-
-
-
Method Detail
-
getEncoding
@Nonnull public java.lang.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 java.io.File file) throws java.io.IOException
Creates anIconwith the specifiedFile.
We here read the specified File and forward the retrieved byte data tofrom(byte[], IconType).- Parameters:
file- An existing, not-null file.- Returns:
- An Icon instance representing the specified File
- Throws:
java.lang.IllegalArgumentException- if the provided file is null, does not exist, or has an unsupported extensionjava.io.IOException- if there is a problem while reading the file.
-
from
@Nonnull public static Icon from(@Nonnull java.io.InputStream stream) throws java.io.IOException
Creates anIconwith the specifiedInputStream.
We here read the specified InputStream and forward the retrieved byte data tofrom(byte[], IconType). This will useIcon.IconType.JPEGbut discord is capable for interpreting other types correctly either way.- Parameters:
stream- A not-null InputStream.- Returns:
- An Icon instance representing the specified InputStream
- Throws:
java.lang.IllegalArgumentException- if the provided stream is nulljava.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.
-
from
@Nonnull public static Icon from(@Nonnull byte[] data)
Creates anIconwith the specified image data. This will useIcon.IconType.JPEGbut discord is capable for interpreting other types correctly either way.- 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
-
from
@Nonnull public static Icon from(@Nonnull java.io.File file, @Nonnull Icon.IconType type) throws java.io.IOException
Creates anIconwith the specifiedFile.
We here read the specified File and forward the retrieved byte data tofrom(byte[], IconType).- Parameters:
file- An existing, not-null file.type- The type of image- Returns:
- An Icon instance representing the specified File
- Throws:
java.lang.IllegalArgumentException- if the provided file is either null or does not existjava.io.IOException- if there is a problem while reading the file.
-
from
@Nonnull public static Icon from(@Nonnull java.io.InputStream stream, @Nonnull Icon.IconType type) throws java.io.IOException
Creates anIconwith the specifiedInputStream.
We here read the specified InputStream and forward the retrieved byte data tofrom(byte[], IconType).- Parameters:
stream- A not-null InputStream.type- The type of image- Returns:
- An Icon instance representing the specified InputStream
- Throws:
java.lang.IllegalArgumentException- if the provided stream is nulljava.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.
-
from
@Nonnull public static Icon from(@Nonnull byte[] data, @Nonnull Icon.IconType type)
Creates anIconwith the specified image data.- Parameters:
data- not-null image data bytes.type- The type of image- Returns:
- An Icon instance representing the specified image data
- Throws:
java.lang.IllegalArgumentException- if the provided data is null
-
-