Record Class SymbolAnalysisEventSummaryDTO

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.platform.models.api.dto.symbol.analysis.SymbolAnalysisEventSummaryDTO

Record Components:

available - available

note - note

nextEarnings - next earnings

upcomingEvents - upcoming events

earningsMoveProfile - earnings move profile

public record SymbolAnalysisEventSummaryDTO(boolean available, String note, SymbolUpcomingEventDTO nextEarnings, List<SymbolUpcomingEventDTO> upcomingEvents, EventMoveProfileDTO earningsMoveProfile)
extends Record

Event-summary DTO.

Version:

2.0.4

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor	Description
SymbolAnalysisEventSummaryDTO(boolean available, String note, SymbolUpcomingEventDTO nextEarnings, List<SymbolUpcomingEventDTO> upcomingEvents, EventMoveProfileDTO earningsMoveProfile)	Creates an instance of a SymbolAnalysisEventSummaryDTO record class.

Method Summary

Modifier and Type	Method	Description
boolean	available()	Returns the value of the available record component.
EventMoveProfileDTO	earningsMoveProfile()	Returns the value of the earningsMoveProfile record component.
static SymbolAnalysisEventSummaryDTO	empty()	Creates an empty DTO shell.
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.
SymbolUpcomingEventDTO	nextEarnings()	Returns the value of the nextEarnings record component.
String	note()	Returns the value of the note record component.
final String	toString()	Returns a string representation of this record class.
List<SymbolUpcomingEventDTO>	upcomingEvents()	Returns the value of the upcomingEvents record component.

Methods inherited from class Object

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

Constructor Details

SymbolAnalysisEventSummaryDTO

public SymbolAnalysisEventSummaryDTO(boolean available,
 String note,
 SymbolUpcomingEventDTO nextEarnings,
 List<SymbolUpcomingEventDTO> upcomingEvents,
 EventMoveProfileDTO earningsMoveProfile)

Creates an instance of a SymbolAnalysisEventSummaryDTO record class.

Parameters:

available - the value for the available record component

note - the value for the note record component

nextEarnings - the value for the nextEarnings record component

upcomingEvents - the value for the upcomingEvents record component

earningsMoveProfile - the value for the earningsMoveProfile record component

Method Details

empty

public static SymbolAnalysisEventSummaryDTO empty()

Creates an empty DTO shell.

Returns:

SymbolAnalysisEventSummaryDTO

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.

available

public boolean available()

Returns the value of the available record component.

Returns:

the value of the available record component

note

public String note()

Returns the value of the note record component.

Returns:

the value of the note record component

nextEarnings

public SymbolUpcomingEventDTO nextEarnings()

Returns the value of the nextEarnings record component.

Returns:

the value of the nextEarnings record component

upcomingEvents

public List<SymbolUpcomingEventDTO> upcomingEvents()

Returns the value of the upcomingEvents record component.

Returns:

the value of the upcomingEvents record component

earningsMoveProfile

public EventMoveProfileDTO earningsMoveProfile()

Returns the value of the earningsMoveProfile record component.

Returns:

the value of the earningsMoveProfile record component