Argon2.Builder

public static class Argon2.Builder extends Object

Public Method Summary

Argon2
build()
Argon2.Builder
setAssociatedData(byte[] associatedData)
Sets additional associated data, if provided, to append to the hash value for additional security.
Argon2.Builder
setHashLengthBytes(int hashLengthBytes)
Sets the hash length in bytes.
Argon2.Builder
setHashType(Argon2.Argon2HashType hashType)
Sets the Argon2 hash type.
Argon2.Builder
setIterations(int iterations)
Sets the number of iterations to perform.
Argon2.Builder
setMemoryCostKib(int memoryCostKib)
Sets the memory cost in kibibytes.
Argon2.Builder
setParallelism(int parallelism)
Sets the degree of parallelism, also called threads or lanes.
Argon2.Builder
setVersion(Argon2.Argon2Version version)
Sets the version of the Argon2 algorithm.

Inherited Method Summary

Public Methods

public Argon2 build ()

public Argon2.Builder setAssociatedData (byte[] associatedData)

Sets additional associated data, if provided, to append to the hash value for additional security. This data is base64 encoded before it is sent to the API.

Parameters
associatedData Associated data as a byte array.
Returns
  • This builder.

public Argon2.Builder setHashLengthBytes (int hashLengthBytes)

Sets the hash length in bytes. Required field.

Parameters
hashLengthBytes an integer between 4 and 1024 (inclusive).
Returns
  • This builder.

public Argon2.Builder setHashType (Argon2.Argon2HashType hashType)

Sets the Argon2 hash type. Required field.

Parameters
hashType a value from the Argon2.Argon2HashType enum.
Returns
  • This builder.

public Argon2.Builder setIterations (int iterations)

Sets the number of iterations to perform. Required field.

Parameters
iterations an integer between 1 and 16 (inclusive).
Returns
  • This builder.

public Argon2.Builder setMemoryCostKib (int memoryCostKib)

Sets the memory cost in kibibytes. Required field.

Parameters
memoryCostKib an integer between 1 and 32768 (inclusive).
Returns
  • This builder.

public Argon2.Builder setParallelism (int parallelism)

Sets the degree of parallelism, also called threads or lanes. Required field.

Parameters
parallelism an integer between 1 and 16 (inclusive).
Returns
  • This builder.

public Argon2.Builder setVersion (Argon2.Argon2Version version)

Sets the version of the Argon2 algorithm.

Parameters
version a value from the Argon2.Argon2Version enum.
Returns
  • This builder.