io.nem.symbol.sdk.model.mosaic

Class Currency

java.lang.Object

io.nem.symbol.sdk.model.mosaic.Currency

public class Currency
extends java.lang.Object

This object holds the configuration of a given currency. The configuration can be provided by user (offline work) or loaded via rest (online work, currently using block/1 transaction).

Some commonly used and known instances are also provided statically if the user wants to work offline.

Objects of this class are created using the CurrencyBuilder and they are thread safe and immutable.

See Also:

CurrencyService, RepositoryFactory, RepositoryFactoryBase, CurrencyBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static Currency	CAT_CURRENCY The original public bootstrap network currency.
static Currency	CAT_HARVEST The original public bootstrap havest currency.
static Currency	SYMBOL_XYM Currency for public / Public_test network.

Method Summary

Modifier and Type	Method and Description
Mosaic	createAbsolute(java.math.BigInteger amount) Create xem with using micro xem as unit, 1 NetworkCurrencyMosaic = 1000000 micro NetworkCurrencyMosaic.
Mosaic	createAbsolute(long amount) Create xem with using micro xem as unit, 1 NetworkCurrencyMosaic = 1000000 micro NetworkCurrencyMosaic.
Mosaic	createRelative(java.math.BigDecimal amount) Create xem with using xem as unit.
Mosaic	createRelative(java.math.BigInteger amount) Create xem with using xem as unit.
Mosaic	createRelative(double amount) Create xem with using xem as unit.
Mosaic	createRelative(long amount) Create xem with using xem as unit.
boolean	equals(java.lang.Object o)
int	getDivisibility()
java.util.Optional<MosaicId>	getMosaicId()
java.util.Optional<NamespaceId>	getNamespaceId()
UnresolvedMosaicId	getUnresolvedMosaicId()
int	hashCode()
boolean	isSupplyMutable()
boolean	isTransferable()

Methods inherited from class java.lang.Object

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

Field Detail

SYMBOL_XYM

public static final Currency SYMBOL_XYM

Currency for public / Public_test network.

This represents the per-network currency mosaic. This mosaicId is aliased with namespace name `symbol.xym`.

This simplifies offline operations but general applications should load the currency from the repository factory and network currency service.

If you are creating a private network and you need offline access, you can create a Currency in memory.

CAT_CURRENCY

public static final Currency CAT_CURRENCY

The original public bootstrap network currency. This is for test only!

CAT_HARVEST

public static final Currency CAT_HARVEST

The original public bootstrap havest currency. This is for test only!

Method Detail

getUnresolvedMosaicId

public UnresolvedMosaicId getUnresolvedMosaicId()

getMosaicId

public java.util.Optional<MosaicId> getMosaicId()

getNamespaceId

public java.util.Optional<NamespaceId> getNamespaceId()

getDivisibility

public int getDivisibility()

isTransferable

public boolean isTransferable()

isSupplyMutable

public boolean isSupplyMutable()

createRelative

public Mosaic createRelative(double amount)

Create xem with using xem as unit.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

createRelative

public Mosaic createRelative(long amount)

Create xem with using xem as unit.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

createRelative

public Mosaic createRelative(java.math.BigDecimal amount)

Create xem with using xem as unit.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

createRelative

public Mosaic createRelative(java.math.BigInteger amount)

Create xem with using xem as unit.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

createAbsolute

public Mosaic createAbsolute(java.math.BigInteger amount)

Create xem with using micro xem as unit, 1 NetworkCurrencyMosaic = 1000000 micro NetworkCurrencyMosaic.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

createAbsolute

public Mosaic createAbsolute(long amount)

Create xem with using micro xem as unit, 1 NetworkCurrencyMosaic = 1000000 micro NetworkCurrencyMosaic.

Parameters:

amount - amount to send

Returns:

a NetworkCurrencyMosaic instance

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object