api / org.gradle.tooling / Failure

Failure

interface Failure

Represents a failure. Failures are similar to exceptions but carry less information (only a message, a description and a cause) so they can be used in a wider scope than just the JVM where the exception failed.

Since
2.4

Functions

getCauses

abstract fun getCauses(): MutableList<out Failure>

Returns the underlying causes for this failure, if any.

getDescription

abstract fun getDescription(): String

Returns a long description of the failure. For example, a stack trace.

getMessage

abstract fun getMessage(): String

Returns a short message (typically one line) for the failure.