net.greghaines.jesque

Class ConfigBuilder

java.lang.Object

net.greghaines.jesque.ConfigBuilder

All Implemented Interfaces:

Serializable

public class ConfigBuilder
extends Object
implements Serializable

A builder for Configs.

Author:

Greg Haines

See Also:

Config, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DATABASE 0
static String	DEFAULT_HOST localhost
static String	DEFAULT_NAMESPACE All resque clients use "resque" by default
static String	DEFAULT_PASSWORD null
static int	DEFAULT_PORT 6379
static int	DEFAULT_TIMEOUT 5 seconds

Constructor Summary

Constructors

Constructor and Description
ConfigBuilder() No-arg constructor
ConfigBuilder(Config startingPoint) Create a new ConfigBuilder using an existing Config as the starting point.

Method Summary

Methods

Modifier and Type	Method and Description
Config	build()
static Config	getDefaultConfig()
ConfigBuilder	withDatabase(int database) Configs created by this ConfigBuilder will use the given Redis database.
ConfigBuilder	withHost(String host) Configs created by this ConfigBuilder will have the given Redis hostname.
ConfigBuilder	withNamespace(String namespace) Configs created by this ConfigBuilder will have the given Redis namespace to prefix keys with.
ConfigBuilder	withPassword(String password) Configs created by this ConfigBuilder will authenticate with the given Redis password.
ConfigBuilder	withPort(int port) Configs created by this ConfigBuilder will have the given Redis port number.
ConfigBuilder	withTimeout(int timeout) Configs created by this ConfigBuilder will have the given Redis connection timeout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

localhost

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

6379

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

5 seconds

See Also:

Constant Field Values

DEFAULT_PASSWORD

public static final String DEFAULT_PASSWORD

null

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

All resque clients use "resque" by default

See Also:

Constant Field Values

DEFAULT_DATABASE

public static final int DEFAULT_DATABASE

0

See Also:

Constant Field Values

Constructor Detail

ConfigBuilder

public ConfigBuilder()

No-arg constructor

ConfigBuilder

public ConfigBuilder(Config startingPoint)

Create a new ConfigBuilder using an existing Config as the starting point.

Parameters:

startingPoint - the Config instance to copy the values from

Method Detail

getDefaultConfig

public static Config getDefaultConfig()

Returns:

a Config with all the default values set

withHost

public ConfigBuilder withHost(String host)

Configs created by this ConfigBuilder will have the given Redis hostname.

Parameters:

host - the Redis hostname

Returns:

this ConfigBuilder

withPort

public ConfigBuilder withPort(int port)

Configs created by this ConfigBuilder will have the given Redis port number.

Parameters:

port - the Redis port number

Returns:

this ConfigBuilder

withTimeout

public ConfigBuilder withTimeout(int timeout)

Configs created by this ConfigBuilder will have the given Redis connection timeout.

Parameters:

timeout - the Redis connection timeout

Returns:

this ConfigBuilder

withPassword

public ConfigBuilder withPassword(String password)

Configs created by this ConfigBuilder will authenticate with the given Redis password.

Parameters:

password - the Redis pasword

Returns:

this ConfigBuilder

withNamespace

public ConfigBuilder withNamespace(String namespace)

Configs created by this ConfigBuilder will have the given Redis namespace to prefix keys with.

Parameters:

namespace - the Redis namespace to prefix keys with

Returns:

this ConfigBuilder

withDatabase

public ConfigBuilder withDatabase(int database)

Configs created by this ConfigBuilder will use the given Redis database.

Parameters:

database - the Redis database to use

Returns:

this ConfigBuilder

build

public Config build()

Returns:

a new Config initialized with the current values