org.iota.jota.builder

Class AccountBuilder

java.lang.Object

org.iota.jota.builder.AbstractBuilder<AccountBuilder,IotaAccount,AccountConfig>

org.iota.jota.builder.AccountBuilder

All Implemented Interfaces:

AccountBuilderSettings, Config, AccountConfig, AccountSettings

Direct Known Subclasses:

IotaAccount.Builder

public class AccountBuilder
extends AbstractBuilder<AccountBuilder,IotaAccount,AccountConfig>
implements AccountSettings

Builder for the account module. Note: Every option added to AccountSettings must add the following:

• A setter, with the same name the option (excluding get), camelcase. Should be equal to the field
• A check in the generate() method to assign
• A default option in IotaDefaultConfig

TODO: Make a reflection unit test for this

Constructor Summary

Constructors

Constructor and Description
AccountBuilder(SeedProvider seed) Start of the builder.
AccountBuilder(String seed) Start of the builder.

Method Summary

Modifier and Type	Method and Description
AccountBuilder	api(IotaAPI api)
AccountBuilder	clock(Clock clock)
protected IotaAccount	compile()
AccountBuilder	depth(int depth)
AccountBuilder	generate()
IotaAPI	getApi()
int	getDepth()
int	getMwm()
List<Plugin>	getPlugins()
int	getSecurityLevel()
SeedProvider	getSeed()
AccountStore	getStore() The storage method we use for storing indexes and unsend transactions
Clock	getTime()
AccountBuilder	mwm(int mwm)
AccountBuilder	plugin(Plugin plugin)
AccountBuilder	securityLevel(int securityLevel)
AccountBuilder	store(AccountStore store)

Methods inherited from class org.iota.jota.builder.AbstractBuilder

build, config, config, config, getConfig, getConfigs

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountBuilder

public AccountBuilder(String seed)
               throws ArgumentException

Start of the builder. Every Account needs to be started with at least a seed.

Parameters:

seed - The seed which we load the account for

Throws:

ArgumentException - When an invalid seed is provided

AccountBuilder

public AccountBuilder(SeedProvider seed)

Start of the builder. Every Account needs to be started with at least a seed.

Parameters:

seed - A custom seed provider for maintaining your seed securely elsewhere

Method Detail

mwm

public AccountBuilder mwm(int mwm)

depth

public AccountBuilder depth(int depth)

securityLevel

public AccountBuilder securityLevel(int securityLevel)

store

public AccountBuilder store(AccountStore store)

api

public AccountBuilder api(IotaAPI api)

clock

public AccountBuilder clock(Clock clock)

plugin

public AccountBuilder plugin(Plugin plugin)

generate

public AccountBuilder generate()
                        throws Exception

Specified by:

generate in class AbstractBuilder<AccountBuilder,IotaAccount,AccountConfig>

Throws:

Exception

compile

protected IotaAccount compile()

Specified by:

compile in class AbstractBuilder<AccountBuilder,IotaAccount,AccountConfig>

getSeed

public SeedProvider getSeed()

Specified by:

getSeed in interface AccountBuilderSettings

getApi

public IotaAPI getApi()

Specified by:

getApi in interface AccountBuilderSettings

getMwm

public int getMwm()

Specified by:

getMwm in interface AccountConfig

Returns:

getDepth

public int getDepth()

Specified by:

getDepth in interface AccountConfig

Returns:

getSecurityLevel

public int getSecurityLevel()

Specified by:

getSecurityLevel in interface AccountConfig

Returns:

getStore

public AccountStore getStore()

Description copied from interface: AccountConfig

The storage method we use for storing indexes and unsend transactions

Specified by:

getStore in interface AccountConfig

Returns:

getTime

public Clock getTime()

Specified by:

getTime in interface AccountBuilderSettings

getPlugins

public List<Plugin> getPlugins()

Specified by:

getPlugins in interface AccountBuilderSettings