org.janusgraph.graphdb.database.management

Class AbstractIndexStatusWatcher<R,S extends AbstractIndexStatusWatcher<R,S>>

java.lang.Object

org.janusgraph.graphdb.database.management.AbstractIndexStatusWatcher<R,S>

All Implemented Interfaces:

Callable<R>

Direct Known Subclasses:

GraphIndexStatusWatcher, RelationIndexStatusWatcher

public abstract class AbstractIndexStatusWatcher<R,S extends AbstractIndexStatusWatcher<R,S>>
extends Object
implements Callable<R>

Field Summary

Fields

Modifier and Type	Field and Description
protected JanusGraph	g
protected Duration	poll
protected List<SchemaStatus>	statuses
protected Duration	timeout

Constructor Summary

Constructors

Constructor and Description
AbstractIndexStatusWatcher(JanusGraph g)

Method Summary

Modifier and Type	Method and Description
S	pollInterval(long poll, TemporalUnit pollUnit) Set the index information polling interval.
protected abstract S	self()
S	status(SchemaStatus... statuses) Set the target index statuses.
S	timeout(long timeout, TemporalUnit timeoutUnit) Set the maximum amount of wall clock time that Callable.call() will wait for the index to reach the target status.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Callable

call

Field Detail

g

protected final JanusGraph g

statuses

protected final List<SchemaStatus> statuses

timeout

protected Duration timeout

poll

protected Duration poll

Constructor Detail

AbstractIndexStatusWatcher

public AbstractIndexStatusWatcher(JanusGraph g)

Method Detail

self

protected abstract S self()

status

public S status(SchemaStatus... statuses)

Set the target index statuses. Callable.call() will repeatedly poll the graph passed into this instance during construction to see whether the index (also passed in during construction) has one of the the supplied statuses.

Parameters:

statuses -

Returns:

timeout

public S timeout(long timeout,
                 TemporalUnit timeoutUnit)

Set the maximum amount of wall clock time that Callable.call() will wait for the index to reach the target status. If the index does not reach the target state in this interval, then Callable.call() will return a report value indicating failure.

A negative timeout is interpreted to mean "wait forever" (no timeout). In this case, the timeoutUnit is ignored.

Parameters:

timeout - the time duration scalar

timeoutUnit - the time unit

Returns:

this builder

pollInterval

public S pollInterval(long poll,
                      TemporalUnit pollUnit)

Set the index information polling interval. Callable.call() waits at least this long between repeated attempts to read schema information and determine whether the index has reached its target state.