org.junit.gen5.engine.reporting

Class ReportEntry

java.lang.Object

org.junit.gen5.engine.reporting.ReportEntry

@API(value=Experimental)
public class ReportEntry
extends java.lang.Object

This class represents a ReportEntry — that is a time-stamped map of String-based key-value pairs to be published to the reporting infrastructure.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	appendDescription(java.lang.Appendable appendable, java.lang.String entryTitle)
static ReportEntry	from(java.util.Map<java.lang.String,java.lang.String> values) Provide a new ReportEntry with the supplied values.
static ReportEntry	from(java.lang.String key, java.lang.String value) Provide a new ReportEntry with the supplied values.
java.time.LocalDateTime	getCreationTimestamp() Get the creation date of this ReportEntry.
java.util.Map<java.lang.String,java.lang.String>	getValues() Get the values to be published.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

from

public static ReportEntry from(java.util.Map<java.lang.String,java.lang.String> values)

Provide a new ReportEntry with the supplied values.

Parameters:

values - the values to be published

from

public static ReportEntry from(java.lang.String key,
                               java.lang.String value)

Provide a new ReportEntry with the supplied values.

Parameters:

key - the key of the value to be published

value - the value to be published

getValues

public java.util.Map<java.lang.String,java.lang.String> getValues()

Get the values to be published.

Returns:

the map of values to be published

getCreationTimestamp

public java.time.LocalDateTime getCreationTimestamp()

Get the creation date of this ReportEntry.

Can be used, for example, to order entries.

Returns:

the date at which this entry was created

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

appendDescription

public void appendDescription(java.lang.Appendable appendable,
                              java.lang.String entryTitle)