_ 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         /**
  29          * Creates a copy of the ExpiryTime
  30          */
  31         public ExpiryTime clone() {
  32                 long ret = bindings.ExpiryTime_clone(this.ptr);
  33                 if (ret >= 0 && ret <= 4096) { return null; }
  34                 ExpiryTime ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ExpiryTime(null, ret); }
  35                 ret_hu_conv.ptrs_to.add(this);
  36                 return ret_hu_conv;
  37         }
  38
  39         /**
  40          * Checks if two ExpiryTimes contain equal inner contents.
  41          */
  42         public long hash() {
  43                 long ret = bindings.ExpiryTime_hash(this.ptr);
  44                 return ret;
  45         }
  46
  47         /**
  48          * Checks if two ExpiryTimes contain equal inner contents.
  49          * This ignores pointers and is_owned flags and looks at the values in fields.
  50          * Two objects with NULL inner values will be considered "equal" here.
  51          */
  52         public boolean eq(ExpiryTime b) {
  53                 boolean ret = bindings.ExpiryTime_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  54                 this.ptrs_to.add(b);
  55                 return ret;
  56         }
  57
  58         /**
  59          * Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
  60          * overflow on adding the `EpiryTime` to it then this function will return a
  61          * `CreationError::ExpiryTimeOutOfBounds`.
  62          */
  63         public static Result_ExpiryTimeCreationErrorZ from_seconds(long seconds) {
  64                 long ret = bindings.ExpiryTime_from_seconds(seconds);
  65                 if (ret >= 0 && ret <= 4096) { return null; }
  66                 Result_ExpiryTimeCreationErrorZ ret_hu_conv = Result_ExpiryTimeCreationErrorZ.constr_from_ptr(ret);
  67                 return ret_hu_conv;
  68         }
  69
  70         /**
  71          * Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
  72          * would overflow on adding the `EpiryTime` to it then this function will return a
  73          * `CreationError::ExpiryTimeOutOfBounds`.
  74          */
  75         public static Result_ExpiryTimeCreationErrorZ from_duration(long duration) {
  76                 long ret = bindings.ExpiryTime_from_duration(duration);
  77                 if (ret >= 0 && ret <= 4096) { return null; }
  78                 Result_ExpiryTimeCreationErrorZ ret_hu_conv = Result_ExpiryTimeCreationErrorZ.constr_from_ptr(ret);
  79                 return ret_hu_conv;
  80         }
  81
  82         /**
  83          * Returns the expiry time in seconds
  84          */
  85         public long as_seconds() {
  86                 long ret = bindings.ExpiryTime_as_seconds(this.ptr);
  87                 return ret;
  88         }
  89
  90         /**
  91          * Returns a reference to the underlying `Duration` (=expiry time)
  92          */
  93         public long as_duration() {
  94                 long ret = bindings.ExpiryTime_as_duration(this.ptr);
  95                 return ret;
  96         }
  97
  98 }