DistributedConfig (OpenClover 4.5.0 API)

java.lang.Object
- com.atlassian.clover.remote.DistributedConfig

All Implemented Interfaces:

Config, Serializable
```
public class DistributedConfig
extends Object
implements Config, Serializable
```
Configuration of the Distributed Coverage feature - server host and port, connection timeout etc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HOST`
`static String`	`NAME`
`static String`	`NUM_CLIENTS`
`static String`	`OFF`
`static String`	`ON`
`static String`	`PORT`
`static String`	`RETRY_PERIOD`
`static String`	`TIMEOUT`

Fields inherited from interface com.atlassian.clover.remote.Config
SEP

Constructor Summary

Constructors
Constructor and Description
`DistributedConfig()` Creates a distributed config using all default values.
`DistributedConfig(String str)` Parses a String of the form: "ON\|OFF\|name=name;host=host;port=port;timeout=timeout;numclients=2;".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConfigString()`
`String`	`getHost()`
`String`	`getName()` Returns the name of this configuration object
`int`	`getNumClients()`
`int`	`getPort()`
`int`	`getRetryPeriod()`
`String`	`getServerLocation()`
`int`	`getTimeout()`
`boolean`	`isEnabled()` Returns true if this config is enabled.
`static DistributedConfig`	`OFF()`
`static DistributedConfig`	`ON()`
`void`	`setHost(String value)`
`void`	`setName(String value)`
`void`	`setNumClients(int value)`
`void`	`setPort(int value)`
`void`	`setRetryPeriod(int value)`
`void`	`setTimeout(int value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - OFF
```
public static final String OFF
```
    See Also:
    
    Constant Field Values
  - ON
```
public static final String ON
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - PORT
```
public static final String PORT
```
    See Also:
    
    Constant Field Values
  - HOST
```
public static final String HOST
```
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
public static final String TIMEOUT
```
    See Also:
    
    Constant Field Values
  - NUM_CLIENTS
```
public static final String NUM_CLIENTS
```
    See Also:
    
    Constant Field Values
  - RETRY_PERIOD
```
public static final String RETRY_PERIOD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DistributedConfig
```
public DistributedConfig(String str)
```
    Parses a String of the form: "ON|OFF|name=name;host=host;port=port;timeout=timeout;numclients=2;".
    If str is "ON" or "on", then this config be enabled with default values for all properties. If str is "OFF" or "off", then this config will be disabled, and no values should be queuried.
    
    Parameters:
    
    str - the configuration data to initialize this Config from.
  - DistributedConfig
```
public DistributedConfig()
```
    Creates a distributed config using all default values.
- Method Detail
  - ON
```
public static DistributedConfig ON()
```
  - OFF
```
public static DistributedConfig OFF()
```
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Config
    
    Returns true if this config is enabled. This should be checked before calling any other methods on the config.
    
    Specified by:
    
    isEnabled in interface Config
    
    Returns:
    
    true if enabled, false otherwise.
  - getName
```
public String getName()
```
    Description copied from interface: Config
    
    Returns the name of this configuration object
    
    Specified by:
    
    getName in interface Config
    
    Returns:
    
    the name of this configuration
  - setName
```
public void setName(String value)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int value)
```
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String value)
```
  - getTimeout
```
public int getTimeout()
```
  - setTimeout
```
public void setTimeout(int value)
```
  - getNumClients
```
public int getNumClients()
```
  - setNumClients
```
public void setNumClients(int value)
```
  - getRetryPeriod
```
public int getRetryPeriod()
```
  - setRetryPeriod
```
public void setRetryPeriod(int value)
```
  - getServerLocation
```
public String getServerLocation()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getConfigString
```
public String getConfigString()
```

Class DistributedConfig

Field Summary

Fields inherited from interface com.atlassian.clover.remote.Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFF

ON

NAME

PORT

HOST

TIMEOUT

NUM_CLIENTS

RETRY_PERIOD

Constructor Detail

DistributedConfig

DistributedConfig

Method Detail

ON

OFF

isEnabled

getName

setName

getPort

setPort

getHost

setHost

getTimeout

setTimeout

getNumClients

setNumClients

getRetryPeriod

setRetryPeriod

getServerLocation

toString

getConfigString