Package land.oras.utils

Enum Class SupportedCompression

java.lang.Object

java.lang.Enum<SupportedCompression>

land.oras.utils.SupportedCompression

All Implemented Interfaces:

Serializable, Comparable<SupportedCompression>, Constable

@NullMarked
public enum SupportedCompression
extends Enum<SupportedCompression>

Supported compression method for archive See @link https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests See @link https://github.com/opencontainers/image-spec/blob/main/descriptor.md#registered-algorithms

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
GZIP	GZIP
NO_COMPRESSION	No compression
ZIP	ZIP
ZSTD	ZSTD

Method Summary

Modifier and Type	Method	Description
static SupportedCompression	fromMediaType(String mediaType)	Get the algorithm from a digest
String	getFileExtension()	Get the file extension
String	getMediaType()	Get the media type
boolean	isAutoUnpack()	Whether the media type is auto unpacked (it's an image layer, not whatever media type the user specified)
static SupportedCompression	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SupportedCompression[]	values()	Returns an array containing the constants of this enum class, 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

NO_COMPRESSION

public static final SupportedCompression NO_COMPRESSION

No compression

ZIP

public static final SupportedCompression ZIP

ZIP

GZIP

public static final SupportedCompression GZIP

GZIP

ZSTD

public static final SupportedCompression ZSTD

ZSTD

Method Details

values

public static SupportedCompression[] values()

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

Returns:

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

valueOf

public static SupportedCompression valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getFileExtension

public String getFileExtension()

Get the file extension

Returns:

The file extension

isAutoUnpack

public boolean isAutoUnpack()

Whether the media type is auto unpacked (it's an image layer, not whatever media type the user specified)

Returns:

True if the media type is auto unpacked by OCI runtime, false otherwise

getMediaType

public String getMediaType()

Get the media type

Returns:

The media type

fromMediaType

public static SupportedCompression fromMediaType(String mediaType)

Get the algorithm from a digest

Parameters:

mediaType - The media type

Returns:

The supported algorithm