PaymentPurpose (LDK Java Bindings and Binaries 0.0.110.2 API)

java.lang.Object
- org.ldk.structs.PaymentPurpose

Direct Known Subclasses:

PaymentPurpose.InvoicePayment, PaymentPurpose.SpontaneousPayment
```
public class PaymentPurpose
extends Object
```
Some information provided on receipt of payment depends on whether the payment received is a spontaneous payment or a \"conventional\" lightning payment that's paying an invoice.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentPurpose.InvoicePayment`	Information for receiving a payment that we generated an invoice for.
`static class`	`PaymentPurpose.SpontaneousPayment`	Because this is a spontaneous payment, the payer generated their own preimage rather than us (the payee) providing a preimage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentPurpose`	`clone()`	Creates a copy of the PaymentPurpose
`protected void`	`finalize()`
`static PaymentPurpose`	`invoice_payment(byte[] payment_preimage, byte[] payment_secret)`	Utility method to constructs a new InvoicePayment-variant PaymentPurpose
`static Result_PaymentPurposeDecodeErrorZ`	`read(byte[] ser)`	Read a PaymentPurpose from a byte array, created by PaymentPurpose_write
`static PaymentPurpose`	`spontaneous_payment(byte[] a)`	Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
`byte[]`	`write()`	Serialize the PaymentPurpose object into a byte array which can be read by PaymentPurpose_read

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

- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - clone
```
public PaymentPurpose clone()
```
    Creates a copy of the PaymentPurpose
    
    Overrides:
    
    clone in class Object
  - invoice_payment
```
public static PaymentPurpose invoice_payment(byte[] payment_preimage,
                                             byte[] payment_secret)
```
    Utility method to constructs a new InvoicePayment-variant PaymentPurpose
  - spontaneous_payment
```
public static PaymentPurpose spontaneous_payment(byte[] a)
```
    Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
  - write
```
public byte[] write()
```
    Serialize the PaymentPurpose object into a byte array which can be read by PaymentPurpose_read
  - read
```
public static Result_PaymentPurposeDecodeErrorZ read(byte[] ser)
```
    Read a PaymentPurpose from a byte array, created by PaymentPurpose_write