discord4j.core.object.util

Class Image

java.lang.Object

discord4j.core.object.util.Image

public final class Image
extends Object

Represents a Discord image.

See Also:

Image Formatting

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.Format The format of an image.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this Image.
String	getData() Gets the data as it would be represented for a Discord request.
Image.Format	getFormat() Gets the format of the image.
String	getHash() Gets the hash of the image.
int	hashCode() Gets the hash code value of the getData() data}.
static Image	ofRaw(byte[] image, Image.Format format) Constructs an Image utilizing raw image data and the Image.Format the image represents.
String	toString() Gets the String represents of this Image.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

ofRaw

public static Image ofRaw(byte[] image,
                          Image.Format format)

Constructs an Image utilizing raw image data and the Image.Format the image represents.

Parameters:

image - The raw image data. Must be non-null.

format - The Image.Format the image represents. Must be non-null.

Returns:

A constructed Image with hashed raw image data and the Image.Format the image represents.

getHash

public String getHash()

Gets the hash of the image.

Returns:

The hash of the image.

getFormat

public Image.Format getFormat()

Gets the format of the image.

Returns:

The format of the image.

getData

public String getData()

Gets the data as it would be represented for a Discord request.

Returns:

The data as it would be represented for a Discord request.

equals

public boolean equals(@Nullable
                      Object obj)

Indicates whether some other object is "equal to" this Image. The other object is considered equal if:

• It is also a Image and;
• Both instances have equal getData() data}.

Overrides:

equals in class Object

Parameters:

obj - An object to be tested for equality.

Returns:

true if the other object is "equal to" this one, false otherwise.

hashCode

public int hashCode()

Gets the hash code value of the getData() data}.

Overrides:

hashCode in class Object

Returns:

The hash code value of the getData() data}.

toString

public String toString()

Gets the String represents of this Image.

The format returned by this method is unspecified and may vary between implementations; however, it is guaranteed to always be non-empty. This method is not suitable for obtaining the data; use getData() instead.

Overrides:

toString in class Object

Returns:

The String representation of this Image.

See Also:

getData()