ProjectIndexerProgressMonitor (Oxygen XML API)

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface ProjectIndexerProgressMonitor

Listener for indexing progress events.

Since:: 24.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancel()`	Event sent when the re-index process was cancelled.
`void`	`endIndexing()`	Event sent when the re-index process finished.
`boolean`	`isCanceled()`	Probing the implementation to check if the indexing should stop.
`void`	`startIndexing()`	Event sent when the re-index process has begun.
`void`	`updateDetailsMessage(java.lang.String detailsMessage)`	Event that signals the status of the indexer has changed.
`void`	`updateIndexedResourcesCount(int count)`	Event that signals the number of indexed resources has increased.

- Method Detail
  - startIndexing
```
void startIndexing()
```
    Event sent when the re-index process has begun.
  - endIndexing
```
void endIndexing()
```
    Event sent when the re-index process finished.
  - cancel
```
void cancel()
```
    Event sent when the re-index process was cancelled.
  - updateDetailsMessage
```
void updateDetailsMessage(java.lang.String detailsMessage)
```
    Event that signals the status of the indexer has changed.
    
    Parameters:
    
    detailsMessage - The message that show the state of the indexer.
  - updateIndexedResourcesCount
```
void updateIndexedResourcesCount(int count)
```
    Event that signals the number of indexed resources has increased. Emmited between a startIndexing() and a endIndexing().
    
    Parameters:
    
    count - The new count.
  - isCanceled
```
boolean isCanceled()
```
    Probing the implementation to check if the indexing should stop.
    
    Returns:
    
    true if the indexing operation was canceled by the user and it should stop.