Package org.ldk.structs

Class OfferFeatures

java.lang.Object

org.ldk.structs.OfferFeatures

public class OfferFeatures
extends Object

Features used within an `offer`.

Method Summary

Modifier and Type	Method	Description
OfferFeatures	clone()	Creates a copy of the OfferFeatures
static OfferFeatures	empty()	Create a blank Features with no features set
boolean	eq(OfferFeatures b)	Checks if two OfferFeaturess contain equal inner contents.
boolean	equals(Object o)
protected void	finalize()
boolean	requires_unknown_bits()	Returns true if this `Features` object contains unknown feature flags which are set as \"required\".
boolean	requires_unknown_bits_from(OfferFeatures other)	Returns true if this `Features` object contains required features unknown by `other`.
Result_NoneNoneZ	set_optional_custom_bit(long bit)	Sets an optional custom feature bit.
Result_NoneNoneZ	set_optional_feature_bit(long bit)	Sets an optional feature bit.
Result_NoneNoneZ	set_required_custom_bit(long bit)	Sets a required custom feature bit.
Result_NoneNoneZ	set_required_feature_bit(long bit)	Sets a required feature bit.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

eq

public boolean eq(OfferFeatures b)

Checks if two OfferFeaturess contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields. Two objects with NULL inner values will be considered "equal" here.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

clone

public OfferFeatures clone()

Creates a copy of the OfferFeatures

Overrides:

clone in class Object

empty

public static OfferFeatures empty()

Create a blank Features with no features set

requires_unknown_bits_from

public boolean requires_unknown_bits_from(OfferFeatures other)

Returns true if this `Features` object contains required features unknown by `other`.

requires_unknown_bits

public boolean requires_unknown_bits()

Returns true if this `Features` object contains unknown feature flags which are set as \"required\".

set_required_feature_bit

public Result_NoneNoneZ set_required_feature_bit(long bit)

Sets a required feature bit. Errors if `bit` is outside the feature range as defined by [BOLT 9]. Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., `bit - 1`). [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md

set_optional_feature_bit

public Result_NoneNoneZ set_optional_feature_bit(long bit)

Sets an optional feature bit. Errors if `bit` is outside the feature range as defined by [BOLT 9]. Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., `bit + 1`). [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md

set_required_custom_bit

public Result_NoneNoneZ set_required_custom_bit(long bit)

Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined by [bLIP 2] or if it is a known `T` feature. Note: Required bits are even. If an odd bit is given, then the corresponding even bit will be set instead (i.e., `bit - 1`). [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits

set_optional_custom_bit

public Result_NoneNoneZ set_optional_custom_bit(long bit)

Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined by [bLIP 2] or if it is a known `T` feature. Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be set instead (i.e., `bit + 1`). [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits