HmacParameters

java.lang.Object
- com.google.crypto.tink.Parameters
- - com.google.crypto.tink.mac.MacParameters
  - - com.google.crypto.tink.mac.HmacParameters

```
@Alpha
public final class HmacParameters
extends MacParameters
```
Describes the parameters of an HmacKey.
This API is annotated with Alpha because it is not yet stable and might be changed in the future.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HmacParameters.Builder` Builds a new HmacParameters instance.
`static class`	`HmacParameters.HashType` The Hash algorithm used.
`static class`	`HmacParameters.Variant` Describes details of the mac computation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HmacParameters.Builder`	`builder()`
`boolean`	`equals(Object o)`
`int`	`getCryptographicTagSizeBytes()` Returns the size of the tag which is computed cryptographically from the message.
`HmacParameters.HashType`	`getHashType()` Returns a hash type object.
`int`	`getKeySizeBytes()`
`int`	`getTotalTagSizeBytes()` Returns the size of the security relevant tag plus the size of the prefix with which this key prefixes every tag.
`HmacParameters.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.
`String`	`toString()`

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

- Method Detail
  - builder
```
public static HmacParameters.Builder builder()
```
  - getKeySizeBytes
```
public int getKeySizeBytes()
```
  - getCryptographicTagSizeBytes
```
public int getCryptographicTagSizeBytes()
```
    Returns the size of the tag which is computed cryptographically from the message.
    This may differ from the total size of the tag, as for some keys, Tink prefixes the tag with a key dependent output prefix.
  - getTotalTagSizeBytes
```
public int getTotalTagSizeBytes()
```
    Returns the size of the security relevant tag plus the size of the prefix with which this key prefixes every tag.
  - getVariant
```
public HmacParameters.Variant getVariant()
```
    Returns a variant object.
  - getHashType
```
public HmacParameters.HashType getHashType()
```
    Returns a hash type object.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class 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 String toString()
```
    Overrides:
    
    toString in class Object

Class HmacParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getKeySizeBytes

getCryptographicTagSizeBytes

getTotalTagSizeBytes

getVariant

getHashType

equals

hashCode

hasIdRequirement

toString