PayloadGarlicConfig (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.message.GarlicConfig
- - net.i2p.router.message.PayloadGarlicConfig

```
public class PayloadGarlicConfig
extends GarlicConfig
```
A GarlicConfig that holds a single I2NPMessage payload with no sub-cloves. This is the leaf node in the garlic clove tree. Every clove in an outbound GarlicMessage is a PayloadGarlicConfig wrapping one I2NPMessage (DataMessage, DeliveryStatusMessage, DatabaseStoreMessage, etc.) along with its delivery instructions. Also used directly by netdb MessageWrapper and tunnel TestJob for single-clove garlic wrapping.

Constructor Summary
Constructors
Constructor and Description
PayloadGarlicConfig(Certificate cert, long id, long expiration, DeliveryInstructions di, I2NPMessage message)

Constructors
Constructor and Description
`PayloadGarlicConfig(Certificate cert, long id, long expiration, DeliveryInstructions di, I2NPMessage message)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClove(GarlicConfig config)` Not supported for single-clove configs.
`void`	`clearCloves()` No-op for single-clove configs.
`GarlicConfig`	`getClove(int index)` Not supported for single-clove configs.
`int`	`getCloveCount()` Return zero, as this is a single-clove config.
`I2NPMessage`	`getPayload()` Specify the I2NP message to be sent - if this is set, no other cloves can be included in this block
`protected String`	`getSubData()` Returns sub-data for toString

Methods inherited from class net.i2p.router.message.GarlicConfig
getCertificate, getDeliveryInstructions, getExpiration, getId, getRecipient, getRecipientPublicKey, setRecipient, setRecipientPublicKey, toString

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

- Constructor Detail
  - PayloadGarlicConfig
```
public PayloadGarlicConfig(Certificate cert,
                           long id,
                           long expiration,
                           DeliveryInstructions di,
                           I2NPMessage message)
```
    Parameters:
    cert - the certificate
    id - the message ID
    expiration - the expiration time
    di - the delivery instructions
    message - the I2NP message payload
- Method Detail
  - addClove
```
public void addClove(GarlicConfig config)
```
    Not supported for single-clove configs.
    Overrides:
    addClove in class GarlicConfig
    Parameters:
    config - the clove config to add
    Throws:
    UnsupportedOperationException - always
  - clearCloves
```
public void clearCloves()
```
    No-op for single-clove configs.
    Overrides:
    clearCloves in class GarlicConfig
  - getClove
```
public GarlicConfig getClove(int index)
```
    Not supported for single-clove configs.
    Overrides:
    getClove in class GarlicConfig
    Parameters:
    index - the index
    Returns:
    the clove
    Throws:
    UnsupportedOperationException - always
  - getCloveCount
```
public int getCloveCount()
```
    Return zero, as this is a single-clove config.
    Overrides:
    getCloveCount in class GarlicConfig
    Returns:
    zero
  - getPayload
```
public I2NPMessage getPayload()
```
    Specify the I2NP message to be sent - if this is set, no other cloves can be included in this block
    Returns:
    the I2NP message payload
  - getSubData
```
protected String getSubData()
```
    Description copied from class: GarlicConfig
    Returns sub-data for toString
    Overrides:
    getSubData in class GarlicConfig
    Returns:
    sub-data string

Class PayloadGarlicConfig

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.message.GarlicConfig

Methods inherited from class java.lang.Object

Constructor Detail

PayloadGarlicConfig

Method Detail

addClove

clearCloves

getClove

getCloveCount

getPayload

getSubData