HybridPrivateKey

java.lang.Object
- com.google.crypto.tink.Key
- - com.google.crypto.tink.hybrid.HybridPrivateKey

All Implemented Interfaces:

PrivateKey

Direct Known Subclasses:

EciesPrivateKey, HpkePrivateKey
```
@Immutable
public abstract class HybridPrivateKey
extends Key
implements PrivateKey
```
Representation of the decryption function for a hybrid encryption primitive.
The encryption function is available via getPublicKey().

Constructor Summary

Constructors
Constructor Description

HybridPrivateKey()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Integer`	`getIdRequirementOrNull()`	Returns null if this key has no id requirement, otherwise the required id.
`Bytes`	`getOutputPrefix()`	Returns a `Bytes` instance, which is prefixed to every ciphertext.
`HybridParameters`	`getParameters()`	Returns a `Parameters` object containing all the information about the key which is not randomly chosen.
`abstract HybridPublicKey`	`getPublicKey()`

Methods inherited from class com.google.crypto.tink.Key
equalsKey

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

- Constructor Detail
  - HybridPrivateKey
```
public HybridPrivateKey()
```
- Method Detail
  - getPublicKey
```
public abstract HybridPublicKey getPublicKey()
```
    Specified by:
    
    getPublicKey in interface PrivateKey
  - getOutputPrefix
```
public final Bytes getOutputPrefix()
```
    Returns a Bytes instance, which is prefixed to every ciphertext.
    Returns the same as getPublicKey().getOutputPrefix().
  - getIdRequirementOrNull
```
@Nullable
public java.lang.Integer getIdRequirementOrNull()
```
    Description copied from class: Key
    
    Returns null if this key has no id requirement, otherwise the required id.
    Some keys, when they are in a keyset, are required to have a certain ID to work properly. This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the string 0x01<id>, where the ID is encoded in big endian (see the documentation of the key type for details), in which case the key requires a certain ID.
    
    Specified by:
    
    getIdRequirementOrNull in class Key
  - getParameters
```
public HybridParameters getParameters()
```
    Description copied from class: Key
    
    Returns a Parameters object containing all the information about the key which is not randomly chosen.
    Implementations need to ensure that getParameters().hasIdRequirement() returns true if and only if getIdRequirementOrNull is non-null.
    
    Specified by:
    
    getParameters in class Key