Package land.oras.utils

Enum Class SupportedAlgorithm

java.lang.Object

java.lang.Enum<SupportedAlgorithm>

land.oras.utils.SupportedAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SupportedAlgorithm>, Constable

@NullMarked
public enum SupportedAlgorithm
extends Enum<SupportedAlgorithm>

Supported algorithms for digest. 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
BLAKE3	BLAKE3
SHA1	SHA-1 This is unsecure, only useful when computing digests for git content (like Flux CD)
SHA256	SHA-256
SHA384	SHA-384
SHA512	SHA-512

Method Summary

Modifier and Type	Method	Description
String	digest(byte[] bytes)	Digest a byte array
String	digest(InputStream inputStream)	Digest an input stream
String	digest(Path file)	Digest a file
static SupportedAlgorithm	fromDigest(@Nullable String digest)	Get the algorithm from a digest
String	getAlgorithmName()	Get the algorithm
static SupportedAlgorithm	getDefault()	Get the default algorithm
static String	getDigest(String digest)	Return the digest without the prefix
String	getPrefix()	Get the prefix
int	getSize()	Get the size of the digest
static boolean	isSupported(String digest)	Check if the digest is supported
static SupportedAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SupportedAlgorithm[]	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

SHA1

public static final SupportedAlgorithm SHA1

SHA-1 This is unsecure, only useful when computing digests for git content (like Flux CD)

SHA256

public static final SupportedAlgorithm SHA256

SHA-256

SHA384

public static final SupportedAlgorithm SHA384

SHA-384

SHA512

public static final SupportedAlgorithm SHA512

SHA-512

BLAKE3

public static final SupportedAlgorithm BLAKE3

BLAKE3

Method Details

values

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

getPrefix

public String getPrefix()

Get the prefix

Returns:

The prefix

getAlgorithmName

public String getAlgorithmName()

Get the algorithm

Returns:

The algorithm

getSize

public int getSize()

Get the size of the digest

Returns:

The size

digest

public String digest(byte[] bytes)

Digest a byte array

Parameters:

bytes - The bytes

Returns:

The digest

digest

public String digest(Path file)

Digest a file

Parameters:

file - The file

Returns:

The digest

digest

public String digest(InputStream inputStream)

Digest an input stream

Parameters:

inputStream - The input stream

Returns:

The digest

isSupported

public static boolean isSupported(String digest)

Check if the digest is supported

Parameters:

digest - The digest

Returns:

True if supported

fromDigest

public static SupportedAlgorithm fromDigest(@Nullable String digest)

Get the algorithm from a digest

Parameters:

digest - The digest

Returns:

The algorithm

getDefault

public static SupportedAlgorithm getDefault()

Get the default algorithm

Returns:

The default algorithm

getDigest

public static String getDigest(String digest)

Return the digest without the prefix

Parameters:

digest - The digest

Returns:

The digest without the prefix