ElGamalSecretBCPGKey
Date: 2016-06-23

org.bouncycastle.bcpg

## Class ElGamalSecretBCPGKey

- java.lang.Object
- - org.bouncycastle.bcpg.BCPGObject
  - - org.bouncycastle.bcpg.ElGamalSecretBCPGKey

- All Implemented Interfaces:
    BCPGKey, org.bouncycastle.util.Encodable

      public class ElGamalSecretBCPGKey
      extends BCPGObject
      implements BCPGKey

  base class for an ElGamal Secret Key.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ElGamalSecretBCPGKey(BCPGInputStream in)`
    `ElGamalSecretBCPGKey(java.math.BigInteger x)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `encode(BCPGOutputStream out)`
    `byte[]` | `getEncoded()` return the standard PGP encoding of the key.
    `java.lang.String` | `getFormat()` return "PGP"
    `java.math.BigInteger` | `getX()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ElGamalSecretBCPGKey

          public ElGamalSecretBCPGKey(BCPGInputStream in)
                               throws java.io.IOException

      Parameters:
        `in` -
      Throws:
        `java.io.IOException`

    - #### ElGamalSecretBCPGKey

          public ElGamalSecretBCPGKey(java.math.BigInteger x)

      Parameters:
        `x` -

  - ### Method Detail

    - #### getFormat

          public java.lang.String getFormat()

      return "PGP"
      Specified by:
        `getFormat` in interface `BCPGKey`
      Returns:
        "RAW" or "PGP"
      See Also:
        `BCPGKey.getFormat()`

    - #### getX

          public java.math.BigInteger getX()

    - #### getEncoded

          public byte[] getEncoded()

      return the standard PGP encoding of the key.
      Specified by:
        `getEncoded` in interface `BCPGKey`
      Specified by:
        `getEncoded` in interface `org.bouncycastle.util.Encodable`
      Overrides:
        `getEncoded` in class `BCPGObject`
      Returns:
        byte[]
      See Also:
        `BCPGKey.getEncoded()`

    - #### encode

          public void encode(BCPGOutputStream out)
                      throws java.io.IOException

      Specified by:
        `encode` in class `BCPGObject`
      Throws:
        `java.io.IOException`