XChaCha20Poly1305Parameters

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

public final class XChaCha20Poly1305Parameters
extends AeadParameters

Describes the parameters of an XChaChaPoly1305Key.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class XChaCha20Poly1305Parameters.Variant
Describes how the prefix is computed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static XChaCha20Poly1305Parameters`	`create()`
`static XChaCha20Poly1305Parameters`	`create(XChaCha20Poly1305Parameters.Variant variant)`
`boolean`	`equals(java.lang.Object o)`
`XChaCha20Poly1305Parameters.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
  - create
```
public static XChaCha20Poly1305Parameters create()
```
  - create
```
public static XChaCha20Poly1305Parameters create(XChaCha20Poly1305Parameters.Variant variant)
```
  - getVariant
```
public XChaCha20Poly1305Parameters.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