org.netbeans.modules.parsing.spi.indexing

Class SuspendStatus

java.lang.Object

org.netbeans.modules.parsing.spi.indexing.SuspendStatus

public final class SuspendStatus
extends Object

A service for indexers to check if an indexing is suspended or to park while indexing is suspended. The indexing is suspended by the infrastructure when high priority request like index query or execution of UserTask, ParserResultTask is in progress. The instance of the SuspendStatus can be obtained from Context.getSuspendStatus(). The infrastructure suspends indexing automatically. The EmbeddingIndexers are suspended with a file granularity. The CustomIndexers are suspended with a source root granularity. This service can be used for more fine granularity suspending especially for CustomIndexers.

Since:

1.52

Method Summary

Modifier and Type	Method and Description
boolean	isSuspended() Checks if an indexing is suspended.
boolean	isSuspendSupported() Checks if a indexing task supports suspend.
void	parkWhileSuspended() Parks a current (caller) thread while an indexing is suspended.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isSuspendSupported

public boolean isSuspendSupported()

Checks if a indexing task supports suspend.

Returns:

true if suspend is supported by the active indexing task.

Since:

1.78

isSuspended

public boolean isSuspended()

Checks if an indexing is suspended.

Returns:

true if an indexing is suspended.

parkWhileSuspended

public void parkWhileSuspended()
                        throws InterruptedException

Parks a current (caller) thread while an indexing is suspended. Threading: The caller should not hold any locks when calling this method.

Throws:

InterruptedException - if the caller is interrupted.