Class PerformanceSectionInfo

java.lang.Object

org.tquadrat.foundation.perflog.internal.PerformanceSectionInfo

@ClassVersion(sourceVersion="$Id: PerformanceSectionInfo.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=INTERNAL,
     since="0.25.0")
public class PerformanceSectionInfo
extends Object

Instances of this class holds the execution status for a "Performance Section".

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: PerformanceSectionInfo.java 1258 2026-06-04 18:33:06Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private long	m_CumulatedExecutionTime	The accumulated execution time of the performance section since the last restart of the program, in milliseconds.
private Instant	m_FirstStart	The time when the performance section was first started after the last restart of the program.
private Instant	m_LastUpdated	The time when this performance section info was last updated.
private int	m_NumberOfAbortedRuns	The number of aborted runs that timed out since the last restart of the program.
private int	m_NumberOfCompletedRuns	The number of runs with an elapsed time since the last restart of the program.
private int	m_NumberOfRunsThatExceededThreshold	The number of runs that exceeded the threshold since the last restart of the program.
private int	m_NumberOfTimedOutRuns	The number of runs that timed out since the last restart of the program.
private final PerformanceSection	m_PerformanceSection	The performance section.
private final AutoLock	m_ReadGuard	The read guard for the statistics attributes.
private final AutoLock	m_WriteGuard	The write guard for the statistics attributes.

Constructor Summary

Constructors

Constructor	Description
PerformanceSectionInfo(String performanceSectionName)	Creates a new instance of PerformanceSectionInfo.
PerformanceSectionInfo(PerformanceSection performanceSection)	Creates a new instance of PerformanceSectionInfo.
PerformanceSectionInfo(PerformanceSectionName performanceSectionName)	Creates a new instance of PerformanceSectionInfo.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)
final OptionalLong	getAverageExecutionTime()	Returns the average execution time of the performance section.
final String	getDescription()	Returns the description for the performance section.
final Optional<ZonedDateTime>	getFirstStart()	Returns the start time for the first execution of the performance section after the last restart of the program.
final Optional<ZonedDateTime>	getLastUpdated()	Returns the time for the last update of this performance section info instance after the last restart of the program.
final PerformanceSectionName	getName()	Returns the name of the performance section.
final OptionalInt	getNumberOfAbortedRuns()	Returns the number of aborted runs.
final OptionalInt	getNumberOfCompletedRuns()	Returns the number of completed runs.
final OptionalInt	getNumberOfRunsThatExceededThreshold()	Returns the number of completed runs that exceeded the threshold.
final OptionalInt	getNumberOfTimedOutRuns()	Returns the number of runs that timed ot.
final PerformanceSection	getPerformanceSection()	Returns the PerformanceSection hold by this PerformanceSectionInfo instance.
final Optional<TimeValue>	getThreshold()	Returns the threshold for the performance section.
final Optional<TimeValue>	getTimeout()	Returns the timeout for this performance section.
final int	hashCode()
final boolean	isAverageAboveThreshold()	Checks whether the average execution time is above the threshold for the performance section.
final boolean	isIgnored()	Returns the flag that controls whether the performance section is currently ignored.
final boolean	isSendingReportOnlyForExceededThreshold()	Returns the flag that indicates whether reports should be sent only if the threshold was exceeded.
final void	processTracker(PerformanceTrackerImpl tracker)	Processes the given performance tracker.
final String	toString()

Methods inherited from class Object

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

Field Details

m_CumulatedExecutionTime

private long m_CumulatedExecutionTime

The accumulated execution time of the performance section since the last restart of the program, in milliseconds.

See Also:

• m_FirstStart

m_FirstStart

private Instant m_FirstStart

The time when the performance section was first started after the last restart of the program.

m_LastUpdated

private Instant m_LastUpdated

The time when this performance section info was last updated. This attribute is used to determine when the report entries for the performance section should be discarded.

m_NumberOfAbortedRuns

private int m_NumberOfAbortedRuns

The number of aborted runs that timed out since the last restart of the program. These are not included in m_NumberOfCompletedRuns.

See Also:

• m_FirstStart

m_NumberOfCompletedRuns

private int m_NumberOfCompletedRuns

The number of runs with an elapsed time since the last restart of the program.

See Also:

• m_FirstStart

m_NumberOfRunsThatExceededThreshold

private int m_NumberOfRunsThatExceededThreshold

The number of runs that exceeded the threshold since the last restart of the program. These are included in m_NumberOfCompletedRuns.

See Also:

• m_FirstStart

m_NumberOfTimedOutRuns

private int m_NumberOfTimedOutRuns

The number of runs that timed out since the last restart of the program. These are not included in m_NumberOfCompletedRuns nor in m_NumberOfAbortedRuns.

See Also:

• m_FirstStart

m_PerformanceSection

private final PerformanceSection m_PerformanceSection

The performance section.

m_ReadGuard

private final AutoLock m_ReadGuard

The read guard for the statistics attributes. These are:

• m_FirstStart
• m_LastUpdated
• m_NumberOfAbortedRuns
• m_NumberOfCompletedRuns
• m_NumberOfRunsThatExceededThreshold
• m_NumberOfTimedOutRuns

m_WriteGuard

private final AutoLock m_WriteGuard

The write guard for the statistics attributes. These are:

• m_FirstStart
• m_LastUpdated
• m_NumberOfAbortedRuns
• m_NumberOfCompletedRuns
• m_NumberOfRunsThatExceededThreshold
• m_NumberOfTimedOutRuns

Constructor Details

PerformanceSectionInfo

public PerformanceSectionInfo(PerformanceSection performanceSection)

Creates a new instance of PerformanceSectionInfo.

Parameters:

performanceSection - The performance section.

PerformanceSectionInfo

public PerformanceSectionInfo(PerformanceSectionName performanceSectionName)

Creates a new instance of PerformanceSectionInfo.

The wrapped PerformanceSection instance will be created on the fly with default values:

• Description: empty
• Threshold: disabled
• Timeout: disabled
• Sending Report for Abort: true
• Active: true

Parameters:

performanceSectionName - The name for a new performance section with default settings.

PerformanceSectionInfo

public PerformanceSectionInfo(String performanceSectionName)

Creates a new instance of PerformanceSectionInfo.

The wrapped PerformanceSection instance will be created on the fly with default values:

• Description: empty
• Threshold: disabled
• Timeout: disabled
• Sending Report for Abort: true
• Active: true

Parameters:

performanceSectionName - The name for a new performance section with default settings.

Method Details

equals

public final boolean equals(Object o)

Two instances of PerformanceSectionInfo are equal if both refer to equal PerformanceSection instances.

Overrides:

equals in class Object

getAverageExecutionTime

public final OptionalLong getAverageExecutionTime()

Returns the average execution time of the performance section.

Returns:

An instance of OptionalLong holding the average execution time in milliseconds. Will be empty if no successful execution was recorded so far.

getDescription

public final String getDescription()

Returns the description for the performance section.

Returns:

The description for the performance section.

getFirstStart

public final Optional<ZonedDateTime> getFirstStart()

Returns the start time for the first execution of the performance section after the last restart of the program.

Returns:

An instance of Optional that holds the first start time.

getLastUpdated

public final Optional<ZonedDateTime> getLastUpdated()

Returns the time for the last update of this performance section info instance after the last restart of the program.

Returns:

An instance of Optional that holds the last update time.

getName

public final PerformanceSectionName getName()

Returns the name of the performance section.

Returns:

The name of the performance section.

getNumberOfAbortedRuns

public final OptionalInt getNumberOfAbortedRuns()

Returns the number of aborted runs. Will be empty if no run was recorded yet.

Runs that timed out are not included in this number.

Returns:

An instance of OptionalInt that holds the number of aborted runs.

getNumberOfCompletedRuns

public final OptionalInt getNumberOfCompletedRuns()

Returns the number of completed runs. These are the runs that provided an elapsed time. Will be empty if no run was recorded yet.

Returns:

An instance of OptionalInt that holds the number of completed runs.

getNumberOfRunsThatExceededThreshold

public final OptionalInt getNumberOfRunsThatExceededThreshold()

Returns the number of completed runs that exceeded the threshold. These runs are also included into the number of completed runs. Will be empty if no run was recorded yet.

Returns:

An instance of OptionalInt that holds the number of completed runs exceeding the threshold.

getNumberOfTimedOutRuns

public final OptionalInt getNumberOfTimedOutRuns()

Returns the number of runs that timed ot. Will be empty if no run was recorded yet.

Runs that were aborted due to other reasons than a timeout are not included in this number.

Returns:

An instance of OptionalInt that holds the number of timed out runs.

getPerformanceSection

public final PerformanceSection getPerformanceSection()

Returns the PerformanceSection hold by this PerformanceSectionInfo instance.

Returns:

The performance section.

getThreshold

public final Optional<TimeValue> getThreshold()

Returns the threshold for the performance section.

Returns:

An instance of OptionalLong that holds the threshold in milliseconds.

getTimeout

public final Optional<TimeValue> getTimeout()

Returns the timeout for this performance section.

Returns:

An instance of OptionalLong that holds the timeout in milliseconds.

hashCode

public final int hashCode()

Two instances of PerformanceSectionInfo are equal if both refer to equal PerformanceSection instances.

Overrides:

hashCode in class Object

isIgnored

public final boolean isIgnored()

Returns the flag that controls whether the performance section is currently ignored.

Returns:

true if the performance section is currently ignored, false if the performance section is currently observed.

isAverageAboveThreshold

public final boolean isAverageAboveThreshold()

Checks whether the average execution time is above the threshold for the performance section. If the threshold is disabled, the method returns false.

Returns:

true if the average execution time is above the threshold, false otherwise.

See Also:

• PerformanceSection.getThreshold()

isSendingReportOnlyForExceededThreshold

public final boolean isSendingReportOnlyForExceededThreshold()

Returns the flag that indicates whether reports should be sent only if the threshold was exceeded.

Returns:

true if a report should be sent only when the threshold was exceeded, false if a report should be sent always.

processTracker

public final void processTracker(PerformanceTrackerImpl tracker)

Processes the given performance tracker.

Parameters:

tracker - The tracker to process.

toString

public final String toString()

Overrides:

toString in class Object