Record Class Report.Section

java.lang.Object

java.lang.Record

com.quantfinlib.report.Report.Section

Enclosing class:

Report

public static record Report.Section(String title, List<String> headers, List<List<String>> rows, String html)
extends Record

A report section: either tabular (headers + rows) or raw HTML content such as an inline SVG chart (html != null). HTML sections are rendered by the HTML exporter only; tabular exporters skip them.

Constructor Summary

Constructors

Constructor	Description
Section(String title, List<String> headers, List<List<String>> rows)
Section(String title, List<String> headers, List<List<String>> rows, String html)	Creates an instance of a Section 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.
List<String>	headers()	Returns the value of the headers record component.
String	html()	Returns the value of the html record component.
boolean	isHtml()
List<List<String>>	rows()	Returns the value of the rows record component.
String	title()	Returns the value of the title 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

Section

public Section(String title,
 List<String> headers,
 List<List<String>> rows)

Section

public Section(String title,
 List<String> headers,
 List<List<String>> rows,
 String html)

Creates an instance of a Section record class.

Parameters:

title - the value for the title record component

headers - the value for the headers record component

rows - the value for the rows record component

html - the value for the html record component

Method Details

isHtml

public boolean isHtml()

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.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

headers

public List<String> headers()

Returns the value of the headers record component.

Returns:

the value of the headers record component

rows

public List<List<String>> rows()

Returns the value of the rows record component.

Returns:

the value of the rows record component

html

public String html()

Returns the value of the html record component.

Returns:

the value of the html record component