Package io.github.pratiyush.totp

Enum Class TOTPException.ErrorCode

java.lang.Object

java.lang.Enum<TOTPException.ErrorCode>

io.github.pratiyush.totp.TOTPException.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<TOTPException.ErrorCode>, Constable

Enclosing class:

TOTPException

public static enum TOTPException.ErrorCode
extends Enum<TOTPException.ErrorCode>

Error codes for programmatic error handling.

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
HMAC_ERROR	HMAC computation failed (algorithm not available, etc.)
INTERNAL_ERROR	Unexpected internal error
INVALID_CODE	Code format is invalid (wrong length, non-numeric, etc.)
INVALID_CONFIG	Configuration parameters are invalid
INVALID_SECRET	Secret is null, empty, too short, or contains invalid characters
QR_GENERATION_ERROR	QR code generation failed

Method Summary

Modifier and Type	Method	Description
static TOTPException.ErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TOTPException.ErrorCode[]	values()	Returns an array containing the constants of this enum class, 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

INVALID_SECRET

public static final TOTPException.ErrorCode INVALID_SECRET

Secret is null, empty, too short, or contains invalid characters

INVALID_CODE

public static final TOTPException.ErrorCode INVALID_CODE

Code format is invalid (wrong length, non-numeric, etc.)

INVALID_CONFIG

public static final TOTPException.ErrorCode INVALID_CONFIG

Configuration parameters are invalid

HMAC_ERROR

public static final TOTPException.ErrorCode HMAC_ERROR

HMAC computation failed (algorithm not available, etc.)

QR_GENERATION_ERROR

public static final TOTPException.ErrorCode QR_GENERATION_ERROR

QR code generation failed

INTERNAL_ERROR

public static final TOTPException.ErrorCode INTERNAL_ERROR

Unexpected internal error

Method Details

values

public static TOTPException.ErrorCode[] 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 TOTPException.ErrorCode 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