Package org.ldk.enums
Enum Recipient
- java.lang.Object
-
- java.lang.Enum<Recipient>
-
- org.ldk.enums.Recipient
-
- All Implemented Interfaces:
Serializable
,Comparable<Recipient>
public enum Recipient extends Enum<Recipient>
Specifies the recipient of an invoice. This indicates to [`NodeSigner::sign_invoice`] what node secret key should be used to sign the invoice.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description LDKRecipient_Node
The invoice should be signed with the local node secret key.LDKRecipient_PhantomNode
The invoice should be signed with the phantom node secret key.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Recipient
valueOf(String name)
Returns the enum constant of this type with the specified name.static Recipient[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LDKRecipient_Node
public static final Recipient LDKRecipient_Node
The invoice should be signed with the local node secret key.
-
LDKRecipient_PhantomNode
public static final Recipient LDKRecipient_PhantomNode
The invoice should be signed with the phantom node secret key. This secret key must be the same for all nodes participating in the [phantom node payment]. [phantom node payment]: PhantomKeysManager
-
-
Method Detail
-
values
public static Recipient[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Recipient c : Recipient.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Recipient valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-