com.google.enterprise.connector.util

Class TraversalTimer

java.lang.Object

com.google.enterprise.connector.util.TraversalTimer

public class TraversalTimer
extends java.lang.Object

A simple timer to control traversal loops and avoid batch timeouts.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
TraversalTimer(TraversalContext traversalContext) Constructs a timer using the time limit of the TraversalContext.

Method Summary

Modifier and Type	Method and Description
boolean	isExpired() Gets whether the timer is expired.
boolean	isTicking() Gets whether the timer is still ticking.
static void	setDefaultTime(long time) Sets the default time in seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversalTimer

public TraversalTimer(TraversalContext traversalContext)

Constructs a timer using the time limit of the TraversalContext.

Parameters:

traversalContext - the traversal context, which may be null

Method Detail

setDefaultTime

public static void setDefaultTime(long time)

Sets the default time in seconds.

isTicking

public boolean isTicking()

Gets whether the timer is still ticking.

Returns:

true if the timer interval has not elapsed, or false if it has elapsed

isExpired

public boolean isExpired()

Gets whether the timer is expired. This is the opposite of isTicking().

Returns:

true if the timer interval has elapsed, or false if it has not elapsed