Package org.myire.scent.report

Class MetricsReportMetaData

java.lang.Object

org.myire.scent.report.MetricsReportMetaData

@Immutable
public class MetricsReportMetaData
extends java.lang.Object

Meta data for a metrics report, such as the time when the report's metrics were collected.

Instances of this class are immutable.

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
MetricsReportMetaData(java.time.LocalDateTime pTimestamp, java.lang.String pVersionString)	Create a new MetricsReportMetaData.

Method Summary

Modifier and Type	Method	Description
java.time.LocalDateTime	getTimestamp()	Get the timestamp when the report's metrics were collected.
java.lang.String	getVersionString()	Get the version of Scent used to collect the report's metrics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsReportMetaData

public MetricsReportMetaData(@Nullable
                             java.time.LocalDateTime pTimestamp,
                             @Nullable
                             java.lang.String pVersionString)

Create a new MetricsReportMetaData.

Parameters:

pTimestamp - The timestamp when the report's metrics were collected, or null if the report shouldn't include a timestamp.

pVersionString - A string with the version of Scent used to collect the metrics, or null if the report shouldn't include a version string.

Method Detail

getTimestamp

@CheckForNull
public java.time.LocalDateTime getTimestamp()

Get the timestamp when the report's metrics were collected.

Returns:

The timestamp, or null if the report shouldn't include a timestamp.

getVersionString

@CheckForNull
public java.lang.String getVersionString()

Get the version of Scent used to collect the report's metrics.

Returns:

A string with the Scent version, or null if the report shouldn't include a version string.