io.nem.symbol.sdk.model.transaction

Class Deadline

java.lang.Object

io.nem.symbol.sdk.model.transaction.Deadline

public class Deadline
extends java.lang.Object

The deadline of the transaction. The deadline is given as the number of seconds elapsed since the creation of the nemesis block. If a transaction does not get included in a block before the deadline is reached, it is deleted.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
Deadline(java.math.BigInteger input) Constructor

Method Summary

Modifier and Type	Method and Description
static Deadline	create(java.time.Duration epochAdjustment) Create the default deadline of 2 hours.
static Deadline	create(java.time.Duration epochAdjustment, int units, java.time.temporal.ChronoUnit chronoUnit) Create deadline model.
java.time.Instant	getInstant(java.time.Duration epochAdjustment) Returns the value as instant
java.time.LocalDateTime	getLocalDateTime(java.time.Duration epochAdjustment) Returns deadline as local date time.
java.time.LocalDateTime	getLocalDateTime(java.time.Duration epochAdjustment, java.time.ZoneId zoneId) Returns deadline as local date time in a given timezone.
long	getValue() Returns number of seconds elapsed since the creation of the nemesis block in milliseconds.
java.math.BigInteger	toBigInteger()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Deadline

public Deadline(java.math.BigInteger input)

Constructor

Parameters:

input - Deadline in BigInteger format

Method Detail

create

public static Deadline create(java.time.Duration epochAdjustment,
                              int units,
                              java.time.temporal.ChronoUnit chronoUnit)

Create deadline model.

Parameters:

epochAdjustment - the network's epoch adjustment. Defined in the network/properties.

units - int

chronoUnit - Chrono unit

Returns:

Deadline

create

public static Deadline create(java.time.Duration epochAdjustment)

Create the default deadline of 2 hours.

Parameters:

epochAdjustment - the network's epoch adjustment. Defined in the network/properties.

Returns:

Deadline

toBigInteger

public java.math.BigInteger toBigInteger()

Returns:

the BigInteger representation of the duration.

getValue

public long getValue()

Returns number of seconds elapsed since the creation of the nemesis block in milliseconds.

Returns:

long

getInstant

public java.time.Instant getInstant(java.time.Duration epochAdjustment)

Returns the value as instant

Parameters:

epochAdjustment - the network's epoch adjustment. Defined in the network/properties.

Returns:

the instant time from the creation of the nemesis block.

getLocalDateTime

public java.time.LocalDateTime getLocalDateTime(java.time.Duration epochAdjustment,
                                                java.time.ZoneId zoneId)

Returns deadline as local date time in a given timezone.

Parameters:

epochAdjustment - the network's epoch adjustment. Defined in the network/properties.

zoneId - Timezone

Returns:

LocalDateTime

getLocalDateTime

public java.time.LocalDateTime getLocalDateTime(java.time.Duration epochAdjustment)

Returns deadline as local date time.

Parameters:

epochAdjustment - the network's epoch adjustment. Defined in the network/properties.

Returns:

LocalDateTime