_ Git - ldk-java/blob - src/main/java/org/ldk/structs/ExpiryTime.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import javax.annotation.Nullable;
   8
   9
  10 /**
  11  * Positive duration that defines when (relatively to the timestamp) in the future the invoice
  12  * expires
  13  *
  14  * # Invariants
  15  * The number of seconds this expiry time represents has to be in the range
  16  * `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
  17  * timestamp
  18  */
  19 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  20 public class ExpiryTime extends CommonBase {
  21         ExpiryTime(Object _dummy, long ptr) { super(ptr); }
  22         @Override @SuppressWarnings("deprecation")
  23         protected void finalize() throws Throwable {
  24                 super.finalize();
  25                 if (ptr != 0) { bindings.ExpiryTime_free(ptr); }
  26         }
  27
  28         long clone_ptr() {
  29                 long ret = bindings.ExpiryTime_clone_ptr(this.ptr);
  30                 return ret;
  31         }
  32
  33         /**
  34          * Creates a copy of the ExpiryTime
  35          */
  36         public ExpiryTime clone() {
  37                 long ret = bindings.ExpiryTime_clone(this.ptr);
  38                 if (ret >= 0 && ret <= 4096) { return null; }
  39                 ExpiryTime ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ExpiryTime(null, ret); }
  40                 ret_hu_conv.ptrs_to.add(this);
  41                 return ret_hu_conv;
  42         }
  43
  44         /**
  45          * Checks if two ExpiryTimes contain equal inner contents.
  46          */
  47         public long hash() {
  48                 long ret = bindings.ExpiryTime_hash(this.ptr);
  49                 return ret;
  50         }
  51
  52         /**
  53          * Checks if two ExpiryTimes contain equal inner contents.
  54          * This ignores pointers and is_owned flags and looks at the values in fields.
  55          * Two objects with NULL inner values will be considered "equal" here.
  56          */
  57         public boolean eq(ExpiryTime b) {
  58                 boolean ret = bindings.ExpiryTime_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  59                 this.ptrs_to.add(b);
  60                 return ret;
  61         }
  62
  63         /**
  64          * Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
  65          * overflow on adding the `EpiryTime` to it then this function will return a
  66          * `CreationError::ExpiryTimeOutOfBounds`.
  67          */
  68         public static Result_ExpiryTimeCreationErrorZ from_seconds(long seconds) {
  69                 long ret = bindings.ExpiryTime_from_seconds(seconds);
  70                 if (ret >= 0 && ret <= 4096) { return null; }
  71                 Result_ExpiryTimeCreationErrorZ ret_hu_conv = Result_ExpiryTimeCreationErrorZ.constr_from_ptr(ret);
  72                 return ret_hu_conv;
  73         }
  74
  75         /**
  76          * Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
  77          * would overflow on adding the `EpiryTime` to it then this function will return a
  78          * `CreationError::ExpiryTimeOutOfBounds`.
  79          */
  80         public static Result_ExpiryTimeCreationErrorZ from_duration(long duration) {
  81                 long ret = bindings.ExpiryTime_from_duration(duration);
  82                 if (ret >= 0 && ret <= 4096) { return null; }
  83                 Result_ExpiryTimeCreationErrorZ ret_hu_conv = Result_ExpiryTimeCreationErrorZ.constr_from_ptr(ret);
  84                 return ret_hu_conv;
  85         }
  86
  87         /**
  88          * Returns the expiry time in seconds
  89          */
  90         public long as_seconds() {
  91                 long ret = bindings.ExpiryTime_as_seconds(this.ptr);
  92                 return ret;
  93         }
  94
  95         /**
  96          * Returns a reference to the underlying `Duration` (=expiry time)
  97          */
  98         public long as_duration() {
  99                 long ret = bindings.ExpiryTime_as_duration(this.ptr);
 100                 return ret;
 101         }
 102
 103 }