Record Class Stats

java.lang.Object

java.lang.Record

com.truebubo.maniflow.stats.Stats

Record Components:

ownsMoney - Money currently owned not tied in assets

ownsStocks - How much of each currency is owned

owesMoney - Money owned via debts

public record Stats(Map<CurrencyDesignation, BigDecimal> ownsMoney, Map<String, BigDecimal> ownsStocks, Map<CurrencyDesignation, BigDecimal> owesMoney)
extends Record

Class to represent stats

Constructor Summary

Constructors

Constructor	Description
Stats(Map<CurrencyDesignation, BigDecimal> ownsMoney, Map<String, BigDecimal> ownsStocks, Map<CurrencyDesignation, BigDecimal> owesMoney)	Creates an instance of a Stats record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<CurrencyDesignation, BigDecimal>	owesMoney()	Returns the value of the owesMoney record component.
Map<CurrencyDesignation, BigDecimal>	ownsMoney()	Returns the value of the ownsMoney record component.
Map<String, BigDecimal>	ownsStocks()	Returns the value of the ownsStocks record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Stats

public Stats(Map<CurrencyDesignation, BigDecimal> ownsMoney,
 Map<String, BigDecimal> ownsStocks,
 Map<CurrencyDesignation, BigDecimal> owesMoney)

Creates an instance of a Stats record class.

Parameters:

ownsMoney - the value for the ownsMoney record component

ownsStocks - the value for the ownsStocks record component

owesMoney - the value for the owesMoney record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

ownsMoney

public Map<CurrencyDesignation, BigDecimal> ownsMoney()

Returns the value of the ownsMoney record component.

Returns:

the value of the ownsMoney record component

ownsStocks

public Map<String, BigDecimal> ownsStocks()

Returns the value of the ownsStocks record component.

Returns:

the value of the ownsStocks record component

owesMoney

public Map<CurrencyDesignation, BigDecimal> owesMoney()

Returns the value of the owesMoney record component.

Returns:

the value of the owesMoney record component