net.corda.finance.contracts

Class Commodity

net.corda.finance.contracts.Commodity

All Implemented Interfaces:

TokenizableAssetInfo

public class Commodity
implements TokenizableAssetInfo

Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the class CommodityContract contract, and is likely to change in future.

See Also:

class CommodityContract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Commodity.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static Commodity.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
Commodity(java.lang.String commodityCode, java.lang.String displayName, int defaultFractionDigits) Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the class CommodityContract contract, and is likely to change in future.

Method Summary

Modifier and Type	Method and Description
java.lang.String	component1()
java.lang.String	component2()
int	component3()
Commodity	copy(java.lang.String commodityCode, java.lang.String displayName, int defaultFractionDigits) Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the class CommodityContract contract, and is likely to change in future.
boolean	equals(java.lang.Object p)
java.lang.String	getCommodityCode()
int	getDefaultFractionDigits()
java.lang.String	getDisplayName()
java.math.BigDecimal	getDisplayTokenSize() The nominal display unit size of a single token, potentially with trailing decimal display places if the scale parameter is non-zero.
int	hashCode()
java.lang.String	toString()

Methods inherited from interface net.corda.core.contracts.TokenizableAssetInfo

getDisplayTokenSize

Field Detail

Companion

public static Commodity.Companion Companion

Constructor Detail

Commodity

public Commodity(java.lang.String commodityCode,
                 java.lang.String displayName,
                 int defaultFractionDigits)

Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the class CommodityContract contract, and is likely to change in future.

Parameters:

commodityCode - a unique code for the commodity. No specific registry for these is currently defined, although this is likely to change in future.

displayName - human readable name for the commodity.

defaultFractionDigits - the number of digits normally after the decimal point when referring to quantities of this commodity.

See Also:

class CommodityContract

Method Detail

getDisplayTokenSize

public java.math.BigDecimal getDisplayTokenSize()

The nominal display unit size of a single token, potentially with trailing decimal display places if the scale parameter is non-zero.

getCommodityCode

public java.lang.String getCommodityCode()

getDisplayName

public java.lang.String getDisplayName()

getDefaultFractionDigits

public int getDefaultFractionDigits()

component1

public java.lang.String component1()

component2

public java.lang.String component2()

component3

public int component3()

copy

public Commodity copy(java.lang.String commodityCode,
                      java.lang.String displayName,
                      int defaultFractionDigits)

Class representing a commodity, as an equivalent to the Currency class. This exists purely to enable the class CommodityContract contract, and is likely to change in future.

Parameters:

commodityCode - a unique code for the commodity. No specific registry for these is currently defined, although this is likely to change in future.

displayName - human readable name for the commodity.

defaultFractionDigits - the number of digits normally after the decimal point when referring to quantities of this commodity.

See Also:

class CommodityContract

toString

public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object p)