org.iota.jota.builder

Class AddressRequest.Builder

java.lang.Object

org.iota.jota.builder.AddressRequest.Builder

Enclosing class:

AddressRequest

public static class AddressRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String seed, int securityLevel) Constructor to instantiate a AddressRequest instance.

Method Summary

Modifier and Type	Method and Description
AddressRequest.Builder	addSpendAddresses(boolean addSpendAddresses) If true, it returns all addresses, even those who were determined to be spent from
AddressRequest.Builder	amount(int amount) Total number of addresses to generate.
AddressRequest	build()
AddressRequest.Builder	checksum(boolean checksum) Adds 9-tryte address checksum.
AddressRequest.Builder	index(int index) Key index to start search from.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String seed,
               int securityLevel)

Constructor to instantiate a AddressRequest instance.

Parameters:

seed - Tryte-encoded seed. It should be noted that this seed is not transferred.

securityLevel - Security level to be used for the private key / address. Can be 1, 2 or 3.

Method Detail

amount

public AddressRequest.Builder amount(int amount)

Total number of addresses to generate. If this is set to 0, we will generate until the first unspent address is found, and stop.

index

public AddressRequest.Builder index(int index)

Key index to start search from.

checksum

public AddressRequest.Builder checksum(boolean checksum)

Adds 9-tryte address checksum. The checksum is required for all an API call.

addSpendAddresses

public AddressRequest.Builder addSpendAddresses(boolean addSpendAddresses)

If true, it returns all addresses, even those who were determined to be spent from

build

public AddressRequest build()