an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
a localized message suitable for presenting to the user
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
an optional Throwable
an optional Formatter
that provides extra information that can be used by reporters in determining
how to present this event to the user
An optional Location
that provides information indicating where in the source code an event originated.
an optional object that can be used to pass custom information to the reporter about the NoteProvided
event
a name for the Thread
about whose activity this event was reported
a Long
indicating the time this event was reported, expressed in terms of the
number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT
Comparing this
event with the event passed as that
.
Comparing this
event with the event passed as that
. Returns
x, where x < 0 iff this < that, x == 0 iff this == that, x > 0 iff this > that.
the event to compare to this event
an optional Formatter
that provides extra information that can be used by reporters in determining
how to present this event to the user
an optional Formatter
that provides extra information that can be used by reporters in determining
how to present this event to the user
An optional Location
that provides information indicating where in the source code an event originated.
An optional Location
that provides information indicating where in the source code an event originated.
a localized message suitable for presenting to the user
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
an optional NameInfo
that if defined, provides names for the suite and optionally the test
in the context of which the information was provided
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
an Ordinal
that can be used to place this event in order in the context of
other events reported during the same run
an optional object that can be used to pass custom information to the reporter about the NoteProvided
event
an optional object that can be used to pass custom information to the reporter about the NoteProvided
event
a name for the Thread
about whose activity this event was reported
a name for the Thread
about whose activity this event was reported
an optional Throwable
a Long
indicating the time this event was reported, expressed in terms of the
number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT
a Long
indicating the time this event was reported, expressed in terms of the
number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT
Event used to provide notifications.
To create instances of this class you may use the factory method. For example, given a report function named
report
, you could fire aNoteProvided
event like this:NoteProvided
differs fromInfoProvided
in that unlikeInfoProvided
,NoteProvided
isn't aRecordableEvent
. If fired because of anote
call from a test, for example, theNoteProvided
will immediately be sent to the reporters rather than being stored and sent in therecordedEvents
field of the test completion event. Thus,NoteProvided
enables "status notifications" to be provided while tests are happening. The difference betweenNoteProvided
andAlertProvided
, which is also a "status notification" fired immediately during tests, is thatAlertProvided
is intended for warnings, where asNoteProvided
is just for information. As an illustration,AlertProvided
messages are displayed in yellow,NoteProvided
in green, in the stdout, stderr, and file reporters.An
NoteProvided
event may be fired from anywhere. In this respectNoteProvided
is different from events for which it is defined whether they are fired in the context of a suite or test. If fired in the context of a test, theNoteProvided
event should include aNameInfo
in whichtestName
is defined. If fired in the context of a suite, but not a test, theNoteProvided
event should include aNameInfo
in whichtestName
is not defined. If fired within the context of neither a suite nor a test, thenameInfo
of theNoteProvided
event (anOption[NameInfo]
) should beNone
.an
Ordinal
that can be used to place this event in order in the context of other events reported during the same runa localized message suitable for presenting to the user
an optional
NameInfo
that if defined, provides names for the suite and optionally the test in the context of which the information was providedan optional
Throwable
an optional
Formatter
that provides extra information that can be used by reporters in determining how to present this event to the userAn optional
Location
that provides information indicating where in the source code an event originated.an optional object that can be used to pass custom information to the reporter about the
NoteProvided
eventa name for the
Thread
about whose activity this event was reporteda
Long
indicating the time this event was reported, expressed in terms of the number of milliseconds since the standard base time known as "the epoch": January 1, 1970, 00:00:00 GMT