Package com.chatmotorapi.api.image

Enum ResponseImageFormat

java.lang.Object

java.lang.Enum<ResponseImageFormat>

com.chatmotorapi.api.image.ResponseImageFormat

All Implemented Interfaces:

Serializable, Comparable<ResponseImageFormat>, java.lang.constant.Constable

public enum ResponseImageFormat
extends Enum<ResponseImageFormat>

Enum representing the format in which an image response can be provided for the ChatMotor Image API. This enum can be used to specify the desired format for image responses.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
B64JSON	Represents a format where the image is provided as a Base64-encoded JSON string.
URL	Represents a format where the image is provided as a URL.

Method Summary

Modifier and Type	Method	Description
static ResponseImageFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponseImageFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

URL

public static final ResponseImageFormat URL

Represents a format where the image is provided as a URL.

B64JSON

public static final ResponseImageFormat B64JSON

Represents a format where the image is provided as a Base64-encoded JSON string.

Method Details

values

public static ResponseImageFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResponseImageFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null