api / org.gradle.tooling.events / ProgressListener

ProgressListener

interface ProgressListener

A listener which is notified when operations that are executed as part of running a build make progress.

See Also
org.gradle.tooling.LongRunningOperation#addProgressListener(ProgressListener)org.gradle.tooling.LongRunningOperation#addProgressListener(ProgressListener, java.util.Set)

Since
2.5

Functions

statusChanged

 abstract fun statusChanged(event: ProgressEvent): Unit

Called when the execution of an operation progresses. The following operation-specific events are currently issued:

  • org.gradle.tooling.events.test.TestStartEvent
  • org.gradle.tooling.events.test.TestFinishEvent
  • org.gradle.tooling.events.task.TaskStartEvent
  • org.gradle.tooling.events.task.TaskFinishEvent
For all other operations, the following generic events are currently issued :
  • StartEvent
  • FinishEvent
You can find out more about the operation for which progress is reported by querying the descriptor using org.gradle.tooling.events.ProgressEvent#getDescriptor().