Record Class Cryptor.KeyDerivationResult

java.lang.Object

java.lang.Record

de.gustavblass.commons.crypto.Cryptor.KeyDerivationResult

Record Components:

derivedKey - The encryption secret that was derived from some human-readable password.

argon2Configuration - The Argon2 parameters that were used to derive the key.

Enclosing class:

Cryptor

public static record Cryptor.KeyDerivationResult(byte @NonNull [] derivedKey, Argon2Configuration argon2Configuration)
extends Record

The result of a key derivation operation.

Field Summary

Fields

Modifier and Type	Field	Description
private final Argon2Configuration	argon2Configuration	The field for the argon2Configuration record component.
private final byte @NonNull []	derivedKey	The field for the derivedKey record component.

Constructor Summary

Constructors

Constructor	Description
KeyDerivationResult(byte @NonNull [] derivedKey, Argon2Configuration argon2Configuration)	Creates an instance of a KeyDerivationResult record class.

Method Summary

Modifier and Type	Method	Description
Argon2Configuration	argon2Configuration()	Returns the value of the argon2Configuration record component.
byte @NonNull []	derivedKey()	Returns the value of the derivedKey record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

derivedKey

private final byte @NonNull [] derivedKey

The field for the derivedKey record component.

argon2Configuration

private final Argon2Configuration argon2Configuration

The field for the argon2Configuration record component.

Constructor Details

KeyDerivationResult

public KeyDerivationResult(byte @NonNull [] derivedKey,
 Argon2Configuration argon2Configuration)

Creates an instance of a KeyDerivationResult record class.

Parameters:

derivedKey - the value for the derivedKey record component

argon2Configuration - the value for the argon2Configuration record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

derivedKey

public byte @NonNull [] derivedKey()

Returns the value of the derivedKey record component.

Returns:

the value of the derivedKey record component

argon2Configuration

public Argon2Configuration argon2Configuration()

Returns the value of the argon2Configuration record component.

Returns:

the value of the argon2Configuration record component