Skip to content

Commit

Permalink
Formatting listeners documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
krmahadevan committed Jan 22, 2024
1 parent e39c1dc commit bf972db
Showing 1 changed file with 74 additions and 15 deletions.
89 changes: 74 additions & 15 deletions src/main/asciidoc/docs/testng_listeners.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,80 @@

There are several interfaces that allow you to modify TestNG's behavior. These interfaces are broadly called "TestNG Listeners". Here are a few listeners:

* IAlterSuiteListener (xref:altering_suites.adoc[doc], {javadocs-base-url}/org/testng/IAlterSuiteListener.html[javadoc])
* IAnnotationTransformer (xref:annotation_transformers.adoc[doc], {javadocs-base-url}/org/testng/IAnnotationTransformer.html[javadoc])
* IConfigurationListener(xref:method_invocations.adoc#_listening_to_configuration_invocations[doc], {javadocs-base-url}/org/testng/IConfigurationListener.html[javadoc])
* IDataProviderListener(xref:method_invocations.adoc#_listening_to_data_provider_invocations[doc], {javadocs-base-url}/org/testng/IDataProviderListener.html[javadoc])
* IExecutionListener(xref:method_invocations.adoc#_listening_to_testng_lifecycle_events[doc], {javadocs-base-url}/org/testng/IExecutionListener.html[javadoc])
* IExecutionVisualiser(doc, {javadocs-base-url}/org/testng/IExecutionVisualiser.html[javadoc])
* IHookable (xref:ihookable.adoc[doc], {javadocs-base-url}/org/testng/IHookable.html[javadoc])
* IConfigurable(xref:iconfigurable.adoc[doc], {javadocs-base-url}/org/testng/IConfigurable.html[javadoc])
* IInvokedMethodListener (xref:method_invocations.adoc#_listening_to_method_invocations[doc], {javadocs-base-url}/org/testng/IInvokedMethodListener.html[javadoc])
* IClassListener(xref:method_invocations.adoc#_listening_to_class_level_invocations[doc], {javadocs-base-url}/org/testng/IClassListener.html[javadoc])
* IMethodInterceptor (xref:method_interceptors.adoc#_method_interceptors[doc], {javadocs-base-url}/org/testng/IMethodInterceptor.html[javadoc])
* IDataProviderInterceptor(xref:method_interceptors.adoc#_interceptors_for_data_providers[doc], {javadocs-base-url}/org/testng/IDataProviderInterceptor.html[javadoc])
* IReporter (xref:logging_and_results.adoc#_logging_reporters[doc], {javadocs-base-url}/org/testng/IReporter.html[javadoc])
* ISuiteListener (xref:method_invocations.adoc#_listening_to_suite_level_invocations[doc], {javadocs-base-url}/org/testng/ISuiteListener.html[javadoc])
* ITestListener (xref:logging_and_results.adoc#_logging_listeners[doc], {javadocs-base-url}/org/testng/ITestListener.html[javadoc])
==== IAlterSuiteListener

Refer xref:altering_suites.adoc[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IAlterSuiteListener.html[here]

==== IAnnotationTransformer

Refer xref:annotation_transformers.adoc[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IAnnotationTransformer.html[here]

==== IConfigurationListener

Refer xref:method_invocations.adoc#_listening_to_configuration_invocations[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IConfigurationListener.html[here]

==== IDataProviderListener

Refer xref:method_invocations.adoc#_listening_to_data_provider_invocations[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IDataProviderListener.html[here]

==== IExecutionListener

Refer xref:method_invocations.adoc#_listening_to_testng_lifecycle_events[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IExecutionListener.html[here]

==== IExecutionVisualiser

Documentation To be included.
Javadocs are available {javadocs-base-url}/org/testng/IExecutionVisualiser.html[here]

==== IHookable

Refer xref:ihookable.adoc[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IHookable.html[here]

==== IConfigurable

Refer xref:iconfigurable.adoc[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IConfigurable.html[here]

==== IInvokedMethodListener

Refer xref:method_invocations.adoc#_listening_to_method_invocations[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IInvokedMethodListener.html[here]

==== IClassListener

Refer xref:method_invocations.adoc#_listening_to_class_level_invocations[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IClassListener.html[here]

==== IMethodInterceptor

Refer xref:method_interceptors.adoc#_method_interceptors[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IMethodInterceptor.html[here]

==== IDataProviderInterceptor

Refer xref:method_interceptors.adoc#_interceptors_for_data_providers[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IDataProviderInterceptor.html[here]

==== IReporter

Refer xref:logging_and_results.adoc#_logging_reporters[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/IReporter.html[here]

==== ISuiteListener

Refer xref:method_invocations.adoc#_listening_to_suite_level_invocations[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/ISuiteListener.html[here]

==== ITestListener

Refer xref:logging_and_results.adoc#_logging_listeners[here] to learn more.
Javadocs are available {javadocs-base-url}/org/testng/ITestListener.html[here]

==== Specifying listeners with testng.xml or in Java

Expand Down

0 comments on commit bf972db

Please sign in to comment.