Package com.google.api.client.testing.util

Class MockBackOff

java.lang.Object

com.google.api.client.testing.util.MockBackOff

All Implemented Interfaces:

BackOff

@Beta
public class MockBackOff
extends java.lang.Object
implements BackOff

Beta
Mock for BackOff that always returns a fixed number.

Implementation is not thread-safe.

Since:

1.15

Field Summary

Fields

Modifier and Type	Field	Description
private long	backOffMillis	Fixed back-off milliseconds.
private int	maxTries	Maximum number of tries before returning BackOff.STOP.
private int	numTries	Number of tries so far.

Fields inherited from interface com.google.api.client.util.BackOff

STOP, STOP_BACKOFF, ZERO_BACKOFF

Constructor Summary

Constructors

Constructor	Description
MockBackOff()

Method Summary

Modifier and Type	Method	Description
int	getMaxTries()	Returns the maximum number of tries before returning BackOff.STOP.
int	getNumberOfTries()	Returns the number of tries so far.
long	nextBackOffMillis()	Gets the number of milliseconds to wait before retrying the operation or BackOff.STOP to indicate that no retries should be made.
void	reset()	Reset to initial state.
MockBackOff	setBackOffMillis(long backOffMillis)	Sets the fixed back-off milliseconds (defaults to 0).
MockBackOff	setMaxTries(int maxTries)	Sets the maximum number of tries before returning BackOff.STOP (defaults to 10).

Methods inherited from class java.lang.Object

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

Field Detail

backOffMillis

private long backOffMillis

Fixed back-off milliseconds.

maxTries

private int maxTries

Maximum number of tries before returning BackOff.STOP.

numTries

private int numTries

Number of tries so far.

Constructor Detail

MockBackOff

public MockBackOff()

Method Detail

reset

public void reset()
           throws java.io.IOException

Description copied from interface: BackOff

Reset to initial state.

Specified by:

reset in interface BackOff

Throws:

java.io.IOException

nextBackOffMillis

public long nextBackOffMillis()
                       throws java.io.IOException

Description copied from interface: BackOff

Gets the number of milliseconds to wait before retrying the operation or BackOff.STOP to indicate that no retries should be made.

Example usage:

 long backOffMillis = backoff.nextBackOffMillis();
 if (backOffMillis == Backoff.STOP) {
 // do not retry operation
 } else {
 // sleep for backOffMillis milliseconds and retry operation
 }
 

Specified by:

nextBackOffMillis in interface BackOff

Throws:

java.io.IOException

setBackOffMillis

public MockBackOff setBackOffMillis(long backOffMillis)

Sets the fixed back-off milliseconds (defaults to 0).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

setMaxTries

public MockBackOff setMaxTries(int maxTries)

Sets the maximum number of tries before returning BackOff.STOP (defaults to 10).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getMaxTries

public final int getMaxTries()

Returns the maximum number of tries before returning BackOff.STOP.

getNumberOfTries

public final int getNumberOfTries()

Returns the number of tries so far.