Package net.dv8tion.jda.api.utils

Class ImageProxy

java.lang.Object

net.dv8tion.jda.api.utils.FileProxy

net.dv8tion.jda.api.utils.ImageProxy

public class ImageProxy
extends FileProxy

A utility class to retrieve images.
This supports downloading the images from the normal URL, as well as downloading the image with a specific size (width is the same as the height).

Constructor Summary

Constructors

Constructor	Description
ImageProxy(String url)	Constructs a new ImageProxy for the provided URL.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<InputStream>	download(int size)	Retrieves the InputStream of this image at the specified size.
CompletableFuture<File>	downloadToFile(File file, int size)	Downloads the data of this image, at the specified size, and stores it in the specified file.
CompletableFuture<Path>	downloadToPath(int size)	Downloads the data of this image, at the specified size, and stores it in a file with the same name as the queried file name (this would be the last segment of the URL).
CompletableFuture<Path>	downloadToPath(Path path, int size)	Downloads the data of this image, at the specified size, and stores it in the specified file.
String	getUrl(int size)	Returns the image URL for the specified size.

Methods inherited from class net.dv8tion.jda.api.utils.FileProxy

download, downloadToFile, downloadToPath, downloadToPath, getUrl, setDefaultHttpClient, withClient

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ImageProxy

public ImageProxy(@Nonnull
 String url)

Constructs a new ImageProxy for the provided URL.

Parameters:

url - The URL to download the image from

Throws:

IllegalArgumentException - If the provided URL is null

Method Details

getUrl

@Nonnull
public String getUrl(int size)

Returns the image URL for the specified size.
The size is a best-effort resize from Discord, with recommended size values as powers of 2 such as 1024 or 512.

Parameters:

size - The size of the image

Returns:

URL of the image with the specified size

download

@Nonnull
@CheckReturnValue
public CompletableFuture<InputStream> download(int size)

Retrieves the InputStream of this image at the specified size.
The image may not be resized at any size, usually Discord only allows for a few powers of 2, so numbers like 128, 256, 512..., 100 might also be a valid size.

If the image is not of a valid size, the CompletableFuture will hold an exception since the HTTP request would have returned a 404.

Parameters:

size - The size of this image

Returns:

CompletableFuture which holds an InputStream, the InputStream must be closed manually.

downloadToPath

@Nonnull
@CheckReturnValue
public CompletableFuture<Path> downloadToPath(int size)

Downloads the data of this image, at the specified size, and stores it in a file with the same name as the queried file name (this would be the last segment of the URL).
The image may not be resized at any size, usually Discord only allows for a few powers of 2, so numbers like 128, 256, 512..., 100 might also be a valid size.

If the image is not of a valid size, the CompletableFuture will hold an exception since the HTTP request would have returned a 404.

Implementation note: The file is first downloaded into a temporary file, the file is then moved to its real destination when the download is complete.

Parameters:

size - The width and height of this image, must be positive

Returns:

CompletableFuture which holds a Path which corresponds to the location the file has been downloaded.

Throws:

IllegalArgumentException - If any of the follow checks are true

• The requested size is negative or 0
• The URL's scheme is neither http or https

downloadToFile

@Nonnull
@CheckReturnValue
public CompletableFuture<File> downloadToFile(@Nonnull
 File file,
 int size)

Downloads the data of this image, at the specified size, and stores it in the specified file.
The image may not be resized at any size, usually Discord only allows for a few powers of 2, so numbers like 128, 256, 512..., 100 might also be a valid size.

If the image is not of a valid size, the CompletableFuture will hold an exception since the HTTP request would have returned a 404.

Implementation note: The file is first downloaded into a temporary file, the file is then moved to its real destination when the download is complete.

Parameters:

file - The file in which to download the image

Returns:

CompletableFuture which holds a File, it is the same as the file passed in the parameters.

Throws:

IllegalArgumentException - If any of the follow checks are true

• The target file is null
• The parent folder of the target file does not exist
• The target file exists and is not a regular file
• The target file exists and is not writable
• The requested size is negative or 0

downloadToPath

@Nonnull
@CheckReturnValue
public CompletableFuture<Path> downloadToPath(@Nonnull
 Path path,
 int size)

Downloads the data of this image, at the specified size, and stores it in the specified file.
The image may not be resized at any size, usually Discord only allows for a few powers of 2, so numbers like 128, 256, 512..., 100 might also be a valid size.

If the image is not of a valid size, the CompletableFuture will hold an exception since the HTTP request would have returned a 404.

Implementation note: The file is first downloaded into a temporary file, the file is then moved to its real destination when the download is complete.
The given path can also target filesystems such as a ZIP filesystem.

Parameters:

path - The file in which to download the image

Returns:

CompletableFuture which holds a Path, it is the same as the path passed in the parameters.

Throws:

IllegalArgumentException - If any of the follow checks are true

• The target path is null
• The parent folder of the target path does not exist
• The target path exists and is not a regular file
• The target path exists and is not writable
• The requested size is negative or 0