Class PerformanceReportImpl

java.lang.Object

org.tquadrat.foundation.perflog.internal.PerformanceReportImpl

All Implemented Interfaces:

PerformanceReport

@ClassVersion(sourceVersion="$Id: PerformanceReportImpl.java 1216 2026-05-02 11:16:24Z tquadrat $")
@API(status=INTERNAL,
     since="0.25.0")
public final class PerformanceReportImpl
extends Object
implements PerformanceReport

The container for report data going to the PerfLogMBean.

The method toJSON() will generate the report message that is distributed through the PerfLogMBean.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerformanceReportImpl.java 1216 2026-05-02 11:16:24Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.perflog.internal.PerformanceReportImpl"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Throwable	m_Cause	The optional cause that was added to the report in case the performance section was aborted.
private final JSONBuilder	m_JSONBuilder	The JSON builder that is used to generated the notification messages.
private final String	m_Message	An optional message that was issued with the report.
private final PerformanceSection	m_Section	The performance section.
private final PerformanceTrackerImpl	m_Tracker	The performance tracker.

Constructor Summary

Constructors

Constructor	Description
PerformanceReportImpl(PerformanceTracker tracker, String message, Throwable cause)	Creates a new instance of PerformanceReportImpl.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)
final Optional<Throwable>	getCause()	Returns the optional cause that was issued with this report.
Optional<String>	getMessage()	Returns the optional message that was issued with this report.
final PerformanceSection	getPerformanceSection()	Returns the performance section that is referred by this report.
final PerformanceTracker	getPerformanceTracker()	Returns the performance tracker that is issued by this report.
final int	hashCode()
final String	toJSON()	Returns the contents of this report instance as a JSON string.
final String	toString()

Methods inherited from class Object

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

Field Details

m_Cause

private final Throwable m_Cause

The optional cause that was added to the report in case the performance section was aborted.

m_JSONBuilder

private final JSONBuilder m_JSONBuilder

The JSON builder that is used to generated the notification messages.

m_Message

private final String m_Message

An optional message that was issued with the report.

m_Section

private final PerformanceSection m_Section

The performance section.

m_Tracker

private final PerformanceTrackerImpl m_Tracker

The performance tracker.

Constructor Details

PerformanceReportImpl

public PerformanceReportImpl(PerformanceTracker tracker,
 String message,
 Throwable cause)

Creates a new instance of PerformanceReportImpl.

Parameters:

tracker - The performance tracker with the data to report.

message - An optional message that was issued with this report.

cause - The optional exception that can be issued in case the performance section was aborted.

Method Details

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

getCause

public final Optional<Throwable> getCause()

Returns the optional cause that was issued with this report.

Specified by:

getCause in interface PerformanceReport

Returns:

An instance of Optional that holds the cause.

getMessage

public Optional<String> getMessage()

Returns the optional message that was issued with this report.

Specified by:

getMessage in interface PerformanceReport

Returns:

An instance of Optional that holds the message.

getPerformanceSection

public final PerformanceSection getPerformanceSection()

Returns the performance section that is referred by this report.

Specified by:

getPerformanceSection in interface PerformanceReport

Returns:

The performance section.

getPerformanceTracker

public final PerformanceTracker getPerformanceTracker()

Returns the performance tracker that is issued by this report.

Specified by:

getPerformanceTracker in interface PerformanceReport

Returns:

The performance tracker.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toJSON

public final String toJSON()

Returns the contents of this report instance as a JSON string.

The JSON has the following structure:

• "PerformanceSection" [Object] – The definition of the PerformanceSection.
  • "Name" [String] – The name of the performance section.
  • "Description" [String] – The description for the performance section.
  • "ThresholdOnlyReport" [Boolean] – Indicates whether a report is sent only when the threshold was exceeded.
  • "Threshold" [optional Object] – The threshold time from the performance section.
    • "Unit" [String] – The dimension.
    • "Value" [Number] – The value.
  • "Timeout" [optional Object] – The timeout time from the performance section.
    • "Unit" [String] – The dimension.
    • "Value" [Number] – The value.
• "StartTime" [String] – The start time; the time when the performance section was entered.
• "ElapsedTime" [optional Object] – The time that was spent in the performance section. Only present when the operation was not aborted.
  • "Unit" [String] – The dimension.
  • "Value" [Number] – The value.
• "Context" [optional Object] – The context for the current execution of the performance section. The member names are specific for the respective performance section.
• "Message" [optional String] – A message that was issued with this report.
• "Cause" [optional String] – An exception that was issued with this report as the reason for aborting the performance section.

Returns:

A JSON formatted representation of this report instance.

toString

public final String toString()

Overrides:

toString in class Object