Package org.aesh.terminal.image

Enum ImageProtocol

java.lang.Object

java.lang.Enum<ImageProtocol>

org.aesh.terminal.image.ImageProtocol

All Implemented Interfaces:

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

public enum ImageProtocol
extends Enum<ImageProtocol>

Supported terminal image protocols.

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
ITERM2	iTerm2 inline images protocol.
KITTY	Kitty graphics protocol.
NONE	No image protocol supported.
SIXEL	Sixel graphics protocol.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ImageProtocol NONE

No image protocol supported.

ITERM2

public static final ImageProtocol ITERM2

iTerm2 inline images protocol. Supported by: iTerm2, WezTerm, Mintty, VSCode terminal, Tabby, Hyper Format: OSC 1337 ; File=[args]:base64data BEL

KITTY

public static final ImageProtocol KITTY

Kitty graphics protocol. Supported by: Kitty, Konsole (partial) Format: APC G [control];[payload] ST

SIXEL

public static final ImageProtocol SIXEL

Sixel graphics protocol. Supported by: xterm, mlterm, foot, Windows Terminal, etc. Not currently implemented.

Method Details

values

public static ImageProtocol[] 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 ImageProtocol 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