HkdfPrfParameters

java.lang.Object
- com.google.crypto.tink.Parameters
- - com.google.crypto.tink.prf.PrfParameters
  - - com.google.crypto.tink.prf.HkdfPrfParameters

public final class HkdfPrfParameters
extends PrfParameters

Describes the parameters of an HkdfPrfKey.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HkdfPrfParameters.Builder`	Builder for HkdfPrfParameters.
`static class`	`HkdfPrfParameters.HashType`	The Hash algorithm used.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HkdfPrfParameters.Builder`	`builder()`
`boolean`	`equals(java.lang.Object o)`
`HkdfPrfParameters.HashType`	`getHashType()`
`int`	`getKeySizeBytes()`
`Bytes`	`getSalt()`	Gets the salt value, which defaults to null if not set, as per RFC 5869.
`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 HkdfPrfParameters.Builder builder()
```
  - getKeySizeBytes
```
public int getKeySizeBytes()
```
  - getHashType
```
public HkdfPrfParameters.HashType getHashType()
```
  - getSalt
```
@Nullable
public Bytes getSalt()
```
    Gets the salt value, which defaults to null if not set, as per RFC 5869. The HKDF PRF implementation must convert a null salt to a string of zeros that is the length of the hash function output.
  - 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