Record Class PointInTimeUniverse.TerminalEvent

java.lang.Object

java.lang.Record

com.quantfinlib.data.PointInTimeUniverse.TerminalEvent

Record Components:

timestamp - when the event takes effect (first bar at/after it applies the event)

type - delisting or merger

delistingReturn - final-day return on the last close (delistings; 0 for mergers)

cashPerShare - merger cash component per share

acquirerSharesPerShare - merger stock component per share

acquirer - acquirer symbol (null for delistings and all-cash deals)

Enclosing class:

PointInTimeUniverse

public static record PointInTimeUniverse.TerminalEvent(long timestamp, PointInTimeUniverse.EventType type, double delistingReturn, double cashPerShare, double acquirerSharesPerShare, String acquirer)
extends Record

A security's terminal event.

Constructor Summary

Constructors

Constructor	Description
TerminalEvent(long timestamp, PointInTimeUniverse.EventType type, double delistingReturn, double cashPerShare, double acquirerSharesPerShare, String acquirer)	Creates an instance of a TerminalEvent record class.

Method Summary

Modifier and Type	Method	Description
String	acquirer()	Returns the value of the acquirer record component.
double	acquirerSharesPerShare()	Returns the value of the acquirerSharesPerShare record component.
double	cashPerShare()	Returns the value of the cashPerShare record component.
double	delistingReturn()	Returns the value of the delistingReturn 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.
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.
PointInTimeUniverse.EventType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

TerminalEvent

public TerminalEvent(long timestamp,
 PointInTimeUniverse.EventType type,
 double delistingReturn,
 double cashPerShare,
 double acquirerSharesPerShare,
 String acquirer)

Creates an instance of a TerminalEvent record class.

Parameters:

timestamp - the value for the timestamp record component

type - the value for the type record component

delistingReturn - the value for the delistingReturn record component

cashPerShare - the value for the cashPerShare record component

acquirerSharesPerShare - the value for the acquirerSharesPerShare record component

acquirer - the value for the acquirer 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.

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

type

public PointInTimeUniverse.EventType type()

Returns the value of the type record component.

Returns:

the value of the type record component

delistingReturn

public double delistingReturn()

Returns the value of the delistingReturn record component.

Returns:

the value of the delistingReturn record component

cashPerShare

public double cashPerShare()

Returns the value of the cashPerShare record component.

Returns:

the value of the cashPerShare record component

acquirerSharesPerShare

public double acquirerSharesPerShare()

Returns the value of the acquirerSharesPerShare record component.

Returns:

the value of the acquirerSharesPerShare record component

acquirer

public String acquirer()

Returns the value of the acquirer record component.

Returns:

the value of the acquirer record component