SkipExecutionHook.SkipResult (documentation 1.5.5 API)

java.lang.Object
- net.jqwik.api.lifecycle.SkipExecutionHook.SkipResult

Enclosing interface:: SkipExecutionHook

public static class SkipExecutionHook.SkipResult
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SkipExecutionHook.SkipResult`	`doNotSkip()`	Create instance of SkipExecutionHook.SkipResult to make the current element not being skipped.
`boolean`	`isSkipped()`	Whether execution of the context should be skipped.
`java.util.Optional<java.lang.String>`	`reason()`	Get the reason that execution of the context should be skipped, if available.
`static SkipExecutionHook.SkipResult`	`skip(java.lang.String reason)`	Create instance of SkipExecutionHook.SkipResult to make the current element being skipped.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - skip
```
public static SkipExecutionHook.SkipResult skip(java.lang.String reason)
```
    Create instance of SkipExecutionHook.SkipResult to make the current element being skipped.
    
    Parameters:
    
    reason - String to describe why the element will be skipped
    
    Returns:
    
    instance of SkipExecutionHook.SkipResult
  - doNotSkip
```
public static SkipExecutionHook.SkipResult doNotSkip()
```
    Create instance of SkipExecutionHook.SkipResult to make the current element not being skipped.
    
    Returns:
    
    instance of SkipExecutionHook.SkipResult
  - isSkipped
```
public boolean isSkipped()
```
    Whether execution of the context should be skipped.
    
    Returns:
    
    true if the execution should be skipped
  - reason
```
public java.util.Optional<java.lang.String> reason()
```
    Get the reason that execution of the context should be skipped, if available. Might not be present, especially when using doNotSkip().
    
    Returns:
    
    instance of Optional<SkipExecutionHook.SkipResult>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object