GarlicClove (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.DataStructureImpl
- - net.i2p.data.i2np.GarlicClove

All Implemented Interfaces:
Serializable, DataStructure
```
public class GarlicClove
extends DataStructureImpl
```
Contains one deliverable message encrypted to a router along with instructions and a certificate 'paying for' the delivery. Note that certificates are always the null certificate at this time, others are unimplemented.
See Also:
Serialized Form

Constructor Summary
Constructors
Constructor and Description
GarlicClove(I2PAppContext context)
GarlicClove.

Constructors
Constructor and Description
`GarlicClove(I2PAppContext context)` GarlicClove.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compare all clove fields for equality.
`int`	`estimateSize()` Estimated serialized length of this clove.
`Certificate`	`getCertificate()` Certificate authorizing delivery of this clove.
`long`	`getCloveId()` Unique identifier for this clove.
`I2NPMessage`	`getData()` The message payload wrapped in this clove.
`long`	`getExpiration()` Time after which this clove expires.
`DeliveryInstructions`	`getInstructions()` How and where to deliver this clove.
`int`	`getSizeRatchet()` Size of the ratchet-format clove.
`int`	`hashCode()` Hash code covering all clove fields.
`int`	`readBytes(byte[] source, int offset)` Read the clove from a byte array.
`void`	`readBytesRatchet(byte[] source, int offset, int len)` Short format for ECIES-Ratchet, saves 22 bytes.
`void`	`setCertificate(Certificate cert)` Certificate authorizing delivery of this clove.
`void`	`setCloveId(long id)` Unique identifier for this clove.
`void`	`setData(I2NPMessage msg)` Message payload wrapped in this clove.
`void`	`setExpiration(long exp)` Time after which this clove expires.
`void`	`setInstructions(DeliveryInstructions instr)` Delivery instructions for this clove.
`byte[]`	`toByteArray()` Serialized clove.
`String`	`toString()` String form for debugging, showing the instructions, expiration, and data.
`int`	`writeBytesRatchet(byte[] tgt, int offset)` Short format for ECIES-Ratchet, saves 22 bytes.

Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64

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

Methods inherited from interface net.i2p.data.DataStructure
readBytes, writeBytes

- Constructor Detail
  - GarlicClove
```
public GarlicClove(I2PAppContext context)
```
    GarlicClove.
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Compare all clove fields for equality.
    Overrides:
    equals in class Object
  - estimateSize
```
public int estimateSize()
```
    Estimated serialized length of this clove.
  - getCertificate
```
public Certificate getCertificate()
```
    Certificate authorizing delivery of this clove.
    Returns:
    the certificate
  - getCloveId
```
public long getCloveId()
```
    Unique identifier for this clove.
    Returns:
    the clove id
  - getData
```
public I2NPMessage getData()
```
    The message payload wrapped in this clove.
    Returns:
    the data
  - getExpiration
```
public long getExpiration()
```
    Time after which this clove expires.
    Returns:
    the expiration
  - getInstructions
```
public DeliveryInstructions getInstructions()
```
    How and where to deliver this clove.
    Returns:
    the instructions
  - getSizeRatchet
```
public int getSizeRatchet()
```
    Size of the ratchet-format clove.
    Returns:
    the ratchet-clove size
  - hashCode
```
public int hashCode()
```
    Hash code covering all clove fields.
    Overrides:
    hashCode in class Object
    Returns:
    whether h code is present
  - readBytes
```
public int readBytes(byte[] source,
                     int offset)
              throws DataFormatException
```
    Read the clove from a byte array.
    Returns:
    length read
    Throws:
    DataFormatException
  - readBytesRatchet
```
public void readBytesRatchet(byte[] source,
                             int offset,
                             int len)
                      throws DataFormatException
```
    Short format for ECIES-Ratchet, saves 22 bytes. NTCP2-style header, no ID, no separate expiration, no cert.
    Throws:
    DataFormatException
  - setCertificate
```
public void setCertificate(Certificate cert)
```
    Certificate authorizing delivery of this clove.
  - setCloveId
```
public void setCloveId(long id)
```
    Unique identifier for this clove.
  - setData
```
public void setData(I2NPMessage msg)
```
    Message payload wrapped in this clove.
  - setExpiration
```
public void setExpiration(long exp)
```
    Time after which this clove expires.
  - setInstructions
```
public void setInstructions(DeliveryInstructions instr)
```
    Delivery instructions for this clove.
  - toByteArray
```
public byte[] toByteArray()
```
    Serialized clove.
    Specified by:
    toByteArray in interface DataStructure
    Overrides:
    toByteArray in class DataStructureImpl
    Returns:
    serialized clove
  - toString
```
public String toString()
```
    String form for debugging, showing the instructions, expiration, and data.
    Overrides:
    toString in class Object
  - writeBytesRatchet
```
public int writeBytesRatchet(byte[] tgt,
                             int offset)
```
    Short format for ECIES-Ratchet, saves 22 bytes. NTCP2-style header, no ID, no separate expiration, no cert.
    Returns:
    new offset

Class GarlicClove

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.DataStructureImpl

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.data.DataStructure

Constructor Detail

GarlicClove

Method Detail

equals

estimateSize

getCertificate

getCloveId

getData

getExpiration

getInstructions

getSizeRatchet

hashCode

readBytes

readBytesRatchet

setCertificate

setCloveId

setData

setExpiration

setInstructions

toByteArray

toString

writeBytesRatchet