NetworkBehavior (retrofit-mock API)

java.lang.Object
- retrofit2.mock.NetworkBehavior

```
public final class NetworkBehavior
extends java.lang.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. Failures will occur 3% of the time. HTTP errors will occur 0% of the time.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`calculateDelay(java.util.concurrent.TimeUnit unit)` Get the delay that should be used for delaying a response in accordance with configured behavior.
`boolean`	`calculateIsError()` Randomly determine whether this call should result in an HTTP error 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(java.util.Random random)` Create an instance with default behavior which uses `random` to control variance and failure calculation.
`retrofit2.Response<?>`	`createErrorResponse()` The HTTP error to be used when an error is triggered.
`long`	`delay(java.util.concurrent.TimeUnit unit)` The network round trip delay.
`int`	`errorPercent()` The percentage of calls to `calculateIsError()` that return `true`.
`java.lang.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, java.util.concurrent.TimeUnit unit)` Set the network round trip delay.
`void`	`setErrorFactory(java.util.concurrent.Callable<retrofit2.Response<?>> errorFactory)` Set the error response factory to be used when an error is triggered.
`void`	`setErrorPercent(int errorPercent)` Set the percentage of calls to `calculateIsError()` that return `true`.
`void`	`setFailureException(java.lang.Throwable exception)` 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(java.util.Random random)
```
    Create an instance with default behavior which uses random to control variance and failure calculation.
  - setDelay
```
public void setDelay(long amount,
                     java.util.concurrent.TimeUnit unit)
```
    Set the network round trip delay.
  - delay
```
public long delay(java.util.concurrent.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(java.lang.Throwable exception)
```
    Set the exception to be used when a failure is triggered.
    It is a best practice to remove the stack trace from exception since it can misleadingly point to code unrelated to this class.
  - failureException
```
public java.lang.Throwable failureException()
```
    The exception to be used when a failure is triggered.
  - errorPercent
```
public int errorPercent()
```
    The percentage of calls to calculateIsError() that return true.
  - setErrorPercent
```
public void setErrorPercent(int errorPercent)
```
    Set the percentage of calls to calculateIsError() that return true.
  - setErrorFactory
```
public void setErrorFactory(java.util.concurrent.Callable<retrofit2.Response<?>> errorFactory)
```
    Set the error response factory to be used when an error is triggered. This factory may only return responses for which Response.isSuccessful() returns false.
  - createErrorResponse
```
public retrofit2.Response<?> createErrorResponse()
```
    The HTTP error to be used when an error 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.
  - calculateIsError
```
public boolean calculateIsError()
```
    Randomly determine whether this call should result in an HTTP error in accordance with configured behavior. When true, createErrorResponse() should be returned.
  - calculateDelay
```
public long calculateDelay(java.util.concurrent.TimeUnit unit)
```
    Get the delay that should be used for delaying a response in accordance with configured behavior.

Class NetworkBehavior

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

setDelay

delay

setVariancePercent

variancePercent

setFailurePercent

failurePercent

setFailureException

failureException

errorPercent

setErrorPercent

setErrorFactory

createErrorResponse

calculateIsFailure

calculateIsError

calculateDelay