Package io.karatelabs.core

Record Class SuiteRunEvent

java.lang.Object

java.lang.Record

io.karatelabs.core.SuiteRunEvent

All Implemented Interfaces:

RunEvent

public record SuiteRunEvent(RunEventType type, Suite source, SuiteResult result, long timeStamp)
extends Record
implements RunEvent

Suite-level events (SUITE_ENTER, SUITE_EXIT).

Constructor Summary

Constructors

Constructor	Description
SuiteRunEvent(RunEventType type, Suite source, SuiteResult result, long timeStamp)	Creates an instance of a SuiteRunEvent record class.

Method Summary

Modifier and Type	Method	Description
static SuiteRunEvent	enter(Suite suite)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static SuiteRunEvent	exit(Suite suite, SuiteResult result)
long	getTimeStamp()	Returns the timestamp when this event occurred (epoch milliseconds).
RunEventType	getType()	Returns the event type.
final int	hashCode()	Returns a hash code value for this object.
SuiteResult	result()	Returns the value of the result record component.
Suite	source()	Returns the value of the source record component.
long	timeStamp()	Returns the value of the timeStamp record component.
Map<String,Object>	toJson()	Serializes this event to a map for JSONL output.
final String	toString()	Returns a string representation of this record class.
RunEventType	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

SuiteRunEvent

public SuiteRunEvent(RunEventType type,
 Suite source,
 SuiteResult result,
 long timeStamp)

Creates an instance of a SuiteRunEvent record class.

Parameters:

type - the value for the type record component

source - the value for the source record component

result - the value for the result record component

timeStamp - the value for the timeStamp record component

Method Details

enter

public static SuiteRunEvent enter(Suite suite)

exit

public static SuiteRunEvent exit(Suite suite,
 SuiteResult result)

getType

public RunEventType getType()

Description copied from interface: RunEvent

Returns the event type.

Specified by:

getType in interface RunEvent

getTimeStamp

public long getTimeStamp()

Description copied from interface: RunEvent

Returns the timestamp when this event occurred (epoch milliseconds).

Specified by:

getTimeStamp in interface RunEvent

toJson

public Map<String,Object> toJson()

Description copied from interface: RunEvent

Serializes this event to a map for JSONL output.

Specified by:

toJson in interface RunEvent

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

type

public RunEventType type()

Returns the value of the type record component.

Returns:

the value of the type record component

source

public Suite source()

Returns the value of the source record component.

Returns:

the value of the source record component

result

public SuiteResult result()

Returns the value of the result record component.

Returns:

the value of the result record component

timeStamp

public long timeStamp()

Returns the value of the timeStamp record component.

Returns:

the value of the timeStamp record component