StackTraceCleaner
Date: 2015-09-18

org.mockito.exceptions.stacktrace

## Interface StackTraceCleaner

- All Known Implementing Classes:
    DefaultStackTraceCleaner

      public interface StackTraceCleaner

  Decides if particular StackTraceElement is excluded from the human-readable stack trace output. Mockito stack trace filtering mechanism uses this information.

  Excluding an element will make it not show in the cleaned stack trace. Not-excluding an element does not guarantee it will be shown (e.g. it depends on the implementation of Mockito internal `StackTraceFilter`).

  The implementations are required to be thread safe. For example, make them stateless.

  See the default implementation: `DefaultStackTraceCleaner`.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `isOut(java.lang.StackTraceElement candidate)` Decides if element is excluded.

- - ### Method Detail

    - #### isOut

          boolean isOut(java.lang.StackTraceElement candidate)

      Decides if element is excluded.
      Parameters:
        `candidate` - element of the actual stack trace
      Returns:
        whether the element should be excluded from cleaned stack trace.