Cancellation - GroupDocs.Search for Java - API Reference

Packages

Skip navigation links

java.lang.Object
- com.groupdocs.search.common.Cancellation

```
public class Cancellation
extends Object
```
Represents an object for requesting cancellation of an operation.
Learn more
- Indexing options
- Search options

Constructor Summary

Constructors
Constructor and Description

Cancellation()
Initializes a new instance of the Cancellation class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Makes a request for cancellation.
`void`	`cancelAfter(int milliseconds)` Makes a request for cancellation after the expiration of specified number of milliseconds.
`protected void`	`finalize()` Finalizes an instance of the `Cancellation` class.
`boolean`	`isCancelled()` Gets a value indicating that cancellation has been requested.

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

- Constructor Detail
  - Cancellation
```
public Cancellation()
```
    Initializes a new instance of the Cancellation class.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Finalizes an instance of the Cancellation class.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - isCancelled
```
public final boolean isCancelled()
```
    Gets a value indicating that cancellation has been requested.
    
    Returns:
    
    A value indicating that cancellation has been requested.
  - cancel
```
public final void cancel()
```
    Makes a request for cancellation.
  - cancelAfter
```
public final void cancelAfter(int milliseconds)
```
    Makes a request for cancellation after the expiration of specified number of milliseconds.
    
    Parameters:
    
    milliseconds - The number of milliseconds after which an operation will be cancelled.