Record Class PositionUtil.PositionClosingMetadata

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.radicle.util.position.PositionUtil.PositionClosingMetadata

Record Components:

returnOnInvestment - percentage return on account balance

returnOnPosition - percentage return on position value

drawdown - market-price-based drawdown

Enclosing class:

PositionUtil

public static record PositionUtil.PositionClosingMetadata(double returnOnInvestment, double returnOnPosition, double drawdown)
extends Record

Computed closing metadata for a Position.

Version:

3.0.1

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
PositionClosingMetadata(double returnOnInvestment, double returnOnPosition, double drawdown)	Creates an instance of a PositionClosingMetadata record class.

Method Summary

Modifier and Type	Method	Description
double	drawdown()	Returns the value of the drawdown record component.
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.
double	returnOnInvestment()	Returns the value of the returnOnInvestment record component.
double	returnOnPosition()	Returns the value of the returnOnPosition record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

PositionClosingMetadata

public PositionClosingMetadata(double returnOnInvestment,
 double returnOnPosition,
 double drawdown)

Creates an instance of a PositionClosingMetadata record class.

Parameters:

returnOnInvestment - the value for the returnOnInvestment record component

returnOnPosition - the value for the returnOnPosition record component

drawdown - the value for the drawdown 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 the compare method from their corresponding wrapper classes.

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.

returnOnInvestment

public double returnOnInvestment()

Returns the value of the returnOnInvestment record component.

Returns:

the value of the returnOnInvestment record component

returnOnPosition

public double returnOnPosition()

Returns the value of the returnOnPosition record component.

Returns:

the value of the returnOnPosition record component

drawdown

public double drawdown()

Returns the value of the drawdown record component.

Returns:

the value of the drawdown record component