MlDsaParameters

java.lang.Object
- com.google.crypto.tink.Parameters
- - com.google.crypto.tink.signature.SignatureParameters
  - - com.google.crypto.tink.signature.MlDsaParameters

public final class MlDsaParameters
extends SignatureParameters

Describes the parameters of ML-DSA signature primitive.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MlDsaParameters.MlDsaInstance`	Describes the parameters set of ML-DSA that is used.
`static class`	`MlDsaParameters.Variant`	Describes details of the ML-DSA signature format.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MlDsaParameters`	`create(MlDsaParameters.MlDsaInstance mlDsaInstance, MlDsaParameters.Variant variant)`	Create an instance with a given parameters set and variant.
`boolean`	`equals(java.lang.Object o)`
`MlDsaParameters.MlDsaInstance`	`getMlDsaInstance()`
`MlDsaParameters.Variant`	`getVariant()`
`int`	`hashCode()`
`boolean`	`hasIdRequirement()`	Returns true if a key created with the parameters in this object has to have a certain ID when it is in a keyset.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static MlDsaParameters create(MlDsaParameters.MlDsaInstance mlDsaInstance,
                                     MlDsaParameters.Variant variant)
```
    Create an instance with a given parameters set and variant.
  - getMlDsaInstance
```
public MlDsaParameters.MlDsaInstance getMlDsaInstance()
```
  - getVariant
```
public MlDsaParameters.Variant getVariant()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - hasIdRequirement
```
public boolean hasIdRequirement()
```
    Description copied from class: Parameters
    
    Returns true if a key created with the parameters in this object has to have a certain ID when it is in a keyset.
    In Tink, certain keys change their behavior depending on the key id (for example, an Aead object can prefix the ciphertext with the big endian encoding of the key id). If this is the case, such a key should require a unique id in Key.getIdRequirementOrNull() and return true here.
    
    Specified by:
    
    hasIdRequirement in class Parameters
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object