Field Detail

• public static final Number DEFAULT_RETRY_INTERVAL

  100 milliseconds

• public static final Number DEFAULT_TIMEOUT

  5 seconds

Property Detail

• String customMessage

• final boolean includeCauseInExceptionMessage

  Whether we should append cause strings to the returned exception message or not

• final Number retryInterval

  How many seconds to wait before trying something again while waiting.

• final Number timeout

  The maximum amount of seconds that something can be waited on.

Constructor Detail

• Wait(Number timeout = DEFAULT_TIMEOUT, Number retryInterval = DEFAULT_RETRY_INTERVAL, boolean includeCauseInExceptionMessage = false)

Method Detail

• boolean equals(def other)

• int hashCode()

• String toString()

• <T> T waitFor(Closure<T> block)

  Invokes the given block every retryInterval seconds until it returns a true value according to the Groovy Truth. If block does not return a truish value within timeout seconds then a WaitTimeoutException will be thrown.

  If the given block is executing at the time when the timeout is reached, it will not be interrupted. This means that this method may take longer than the specified timeout. For example, if the block takes 5 seconds to complete but the timeout is 2 seconds, the wait is always going to take at least 5 seconds.

  If block throws any Throwable, it is treated as a failure and the block will be tried again after the retryInterval has expired. If the last invocation of block throws an exception it will be the cause of the WaitTimeoutException that will be thrown.