com.hazelcast.config

Class LockConfig

java.lang.Object

com.hazelcast.config.LockConfig

public class LockConfig
extends Object

Contains the configuration for the ILock.

Constructor Summary

Constructors

Constructor and Description
LockConfig()
LockConfig(LockConfig config) Clones a LockConfig
LockConfig(String name) Creates a LockConfig with the provided name.
LockConfig(String name, LockConfig config) Creates a new LockConfig by cloning an existing config and overriding the name.

Method Summary

Modifier and Type	Method and Description
LockConfig	getAsReadOnly() Deprecated. this method will be removed in 4.0; it is meant for internal usage only.
String	getName() Returns the name of the lock.
String	getQuorumName() Returns the quorum name for lock operations.
LockConfig	setName(String name) Sets the name of the lock.
LockConfig	setQuorumName(String quorumName) Sets the quorum name for lock operations.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LockConfig

public LockConfig()

LockConfig

public LockConfig(String name)

Creates a LockConfig with the provided name.

Parameters:

name - the name

Throws:

NullPointerException - if name is null

LockConfig

public LockConfig(LockConfig config)

Clones a LockConfig

Parameters:

config - the lock config to clone

Throws:

NullPointerException - if config is null

LockConfig

public LockConfig(String name,
                  LockConfig config)

Creates a new LockConfig by cloning an existing config and overriding the name.

Parameters:

name - the new name

config - the config.

Throws:

NullPointerException - if name or config is null.

Method Detail

setName

public LockConfig setName(String name)

Sets the name of the lock.

Parameters:

name - the name of the lock

Returns:

the updated LockConfig

Throws:

IllegalArgumentException - if name is null or an empty string.

getName

public String getName()

Returns the name of the lock.

Returns:

the name of the lock.

getQuorumName

public String getQuorumName()

Returns the quorum name for lock operations.

Returns:

the quorum name

setQuorumName

public LockConfig setQuorumName(String quorumName)

Sets the quorum name for lock operations.

Parameters:

quorumName - the quorum name

Returns:

the updated lock configuration

getAsReadOnly

public LockConfig getAsReadOnly()

Deprecated. this method will be removed in 4.0; it is meant for internal usage only.

Gets immutable version of this configuration.

Returns:

Immutable version of this configuration.

toString

public String toString()

Overrides:

toString in class Object