retrofit.mock

Class NetworkBehavior

java.lang.Object

retrofit.mock.NetworkBehavior

public final class NetworkBehavior
extends Object

A simple emulation of the behavior of network calls.

This class models three properties of a network:

• Delay – the time it takes before a response is received (successful or otherwise).
• Variance – the amount of fluctuation of the delay to be faster or slower.
• Failure - the percentage of operations which fail (such as IOException).

Behavior can be applied to a Retrofit interface with MockRetrofit. Behavior can also be applied elsewhere using calculateDelay(TimeUnit) and calculateIsFailure().

By default, instances of this class will use a 2 second delay with 40% variance and failures will occur 3% of the time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NetworkBehavior.Adapter<T> Applies NetworkBehavior to instances of T.

Method Summary

Modifier and Type	Method and Description
long	calculateDelay(TimeUnit unit) Get the delay that should be used for delaying a response in accordance with configured behavior.
boolean	calculateIsFailure() Randomly determine whether this call should result in a network failure in accordance with configured behavior.
static NetworkBehavior	create() Create an instance with default behavior.
static NetworkBehavior	create(Random random) Create an instance with default behavior which uses random to control variance and failure calculation.
long	delay(TimeUnit unit) The network round trip delay.
Throwable	failureException() The exception to be used when a failure is triggered.
int	failurePercent() The percentage of calls to calculateIsFailure() that return true.
void	setDelay(long amount, TimeUnit unit) Set the network round trip delay.
void	setFailureException(Throwable t) Set the exception to be used when a failure is triggered.
void	setFailurePercent(int failurePercent) Set the percentage of calls to calculateIsFailure() that return true.
void	setVariancePercent(int variancePercent) Set the plus-or-minus variance percentage of the network round trip delay.
int	variancePercent() The plus-or-minus variance percentage of the network round trip delay.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static NetworkBehavior create()

Create an instance with default behavior.

create

public static NetworkBehavior create(Random random)

Create an instance with default behavior which uses random to control variance and failure calculation.

setDelay

public void setDelay(long amount,
                     TimeUnit unit)

Set the network round trip delay.

delay

public long delay(TimeUnit unit)

The network round trip delay.

setVariancePercent

public void setVariancePercent(int variancePercent)

Set the plus-or-minus variance percentage of the network round trip delay.

variancePercent

public int variancePercent()

The plus-or-minus variance percentage of the network round trip delay.

setFailurePercent

public void setFailurePercent(int failurePercent)

Set the percentage of calls to calculateIsFailure() that return true.

failurePercent

public int failurePercent()

The percentage of calls to calculateIsFailure() that return true.

setFailureException

public void setFailureException(Throwable t)

Set the exception to be used when a failure is triggered.

failureException

public Throwable failureException()

The exception to be used when a failure is triggered.

calculateIsFailure

public boolean calculateIsFailure()

Randomly determine whether this call should result in a network failure in accordance with configured behavior. When true, failureException() should be thrown.

calculateDelay

public long calculateDelay(TimeUnit unit)

Get the delay that should be used for delaying a response in accordance with configured behavior.