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)` equals.
`int`	`estimateSize()` estimateSize.
`Certificate`	`getCertificate()`
`long`	`getCloveId()`
`I2NPMessage`	`getData()`
`long`	`getExpiration()`
`DeliveryInstructions`	`getInstructions()`
`int`	`getSizeRatchet()`
`int`	`hashCode()`
`int`	`readBytes(byte[] source, int offset)`
`void`	`readBytesRatchet(byte[] source, int offset, int len)` Short format for ECIES-Ratchet, saves 22 bytes.
`void`	`setCertificate(Certificate cert)` setCertificate.
`void`	`setCloveId(long id)` setCloveId.
`void`	`setData(I2NPMessage msg)` setData.
`void`	`setExpiration(long exp)` setExpiration.
`void`	`setInstructions(DeliveryInstructions instr)` setInstructions.
`byte[]`	`toByteArray()` Convert the structure to a byte array.
`String`	`toString()` toString.
`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)
```
    equals.
    Overrides:
    equals in class Object
  - estimateSize
```
public int estimateSize()
```
    estimateSize.
  - getCertificate
```
public Certificate getCertificate()
```
    Returns:
    the certificate
  - getCloveId
```
public long getCloveId()
```
    Returns:
    the clove id
  - getData
```
public I2NPMessage getData()
```
    Returns:
    the data
  - getExpiration
```
public long getExpiration()
```
    Returns:
    the expiration
  - getInstructions
```
public DeliveryInstructions getInstructions()
```
    Returns:
    the instructions
  - getSizeRatchet
```
public int getSizeRatchet()
```
    Returns:
    the size ratchet
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
    Returns:
    whether h code is present
  - readBytes
```
public int readBytes(byte[] source,
                     int offset)
              throws DataFormatException
```
    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)
```
    setCertificate.
  - setCloveId
```
public void setCloveId(long id)
```
    setCloveId.
  - setData
```
public void setData(I2NPMessage msg)
```
    setData.
  - setExpiration
```
public void setExpiration(long exp)
```
    setExpiration.
  - setInstructions
```
public void setInstructions(DeliveryInstructions instr)
```
    setInstructions.
  - toByteArray
```
public byte[] toByteArray()
```
    Description copied from interface: DataStructure
    Convert the structure to a byte array.
    Specified by:
    toByteArray in interface DataStructure
    Overrides:
    toByteArray in class DataStructureImpl
    Returns:
    serialized clove
  - toString
```
public String toString()
```
    toString.
    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