AesGcmSivParameters

java.lang.Object
- com.google.crypto.tink.Parameters
- - com.google.crypto.tink.aead.AeadParameters
  - - com.google.crypto.tink.aead.AesGcmSivParameters

public final class AesGcmSivParameters
extends AeadParameters

Describes the parameters of an AesGcmSivSivKey

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AesGcmSivParameters.Builder`	Builds a new AesGcmSivParameters instance.
`static class`	`AesGcmSivParameters.Variant`	Describes how the prefix is computed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AesGcmSivParameters.Builder`	`builder()`
`boolean`	`equals(java.lang.Object o)`
`int`	`getKeySizeBytes()`
`AesGcmSivParameters.Variant`	`getVariant()`	Returns a variant object.
`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
  - builder
```
public static AesGcmSivParameters.Builder builder()
```
  - getKeySizeBytes
```
public int getKeySizeBytes()
```
  - getVariant
```
public AesGcmSivParameters.Variant getVariant()
```
    Returns a variant object.
  - 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