Record Class CorporateActions.CorporateAction

java.lang.Object

java.lang.Record

com.quantfinlib.data.CorporateActions.CorporateAction

Record Components:

exTimestamp - first bar timestamp trading on the adjusted basis

value - split ratio (2 = 2-for-1) or cash dividend per share

Enclosing class:

CorporateActions

public static record CorporateActions.CorporateAction(long exTimestamp, CorporateActions.Type type, double value)
extends Record

Constructor Summary

Constructors

Constructor	Description
CorporateAction(long exTimestamp, CorporateActions.Type type, double value)	Creates an instance of a CorporateAction record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	exTimestamp()	Returns the value of the exTimestamp record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
CorporateActions.Type	type()	Returns the value of the type record component.
double	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

CorporateAction

public CorporateAction(long exTimestamp,
 CorporateActions.Type type,
 double value)

Creates an instance of a CorporateAction record class.

Parameters:

exTimestamp - the value for the exTimestamp record component

type - the value for the type record component

value - the value for the value 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

exTimestamp

public long exTimestamp()

Returns the value of the exTimestamp record component.

Returns:

the value of the exTimestamp record component

type

public CorporateActions.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

value

public double value()

Returns the value of the value record component.

Returns:

the value of the value record component