Class FailOnTimeout.Builder

  • Enclosing class:
    FailOnTimeout

    public static class FailOnTimeout.Builder
    extends java.lang.Object
    Builder for FailOnTimeout.
    Since:
    4.12
    • Field Detail

      • lookForStuckThread

        private boolean lookForStuckThread
      • timeout

        private long timeout
      • unit

        private java.util.concurrent.TimeUnit unit
    • Constructor Detail

      • Builder

        private Builder()
    • Method Detail

      • withTimeout

        public FailOnTimeout.Builder withTimeout​(long timeout,
                                                 java.util.concurrent.TimeUnit unit)
        Specifies the time to wait before timing out the test.

        If this is not called, or is called with a timeout of 0, the returned Statement will wait forever for the test to complete, however the test will still launch from a separate thread. This can be useful for disabling timeouts in environments where they are dynamically set based on some property.

        Parameters:
        timeout - the maximum time to wait
        unit - the time unit of the timeout argument
        Returns:
        this for method chaining.
      • withLookingForStuckThread

        public FailOnTimeout.Builder withLookingForStuckThread​(boolean enable)
        Specifies whether to look for a stuck thread. If a timeout occurs and this feature is enabled, the test will look for a thread that appears to be stuck and dump its backtrace. This feature is experimental. Behavior may change after the 4.12 release in response to feedback.
        Parameters:
        enable - true to enable the feature
        Returns:
        this for method chaining.
      • build

        public FailOnTimeout build​(Statement statement)
        Builds a FailOnTimeout instance using the values in this builder, wrapping the given statement.
        Parameters:
        statement -