org.axonframework.common.lock

Enum NullLockFactory

java.lang.Object

java.lang.Enum<NullLockFactory>

org.axonframework.common.lock.NullLockFactory

All Implemented Interfaces:

Serializable, Comparable<NullLockFactory>, LockFactory

public enum NullLockFactory
extends Enum<NullLockFactory>
implements LockFactory

LockFactory implementation that does nothing. Can be useful in cases where a Locking Repository implementation needs to be configured to ignore locks, for example in scenario's where an underlying storage mechanism already performs the necessary locking.

Since:

0.6

Author:

Allard Buijze

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton instance of a NullLockFactory.

Method Summary

Modifier and Type	Method and Description
Lock	obtainLock(String identifier) Obtain a lock for a resource identified by given identifier.
static NullLockFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static NullLockFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final NullLockFactory INSTANCE

Singleton instance of a NullLockFactory.

Method Detail

values

public static NullLockFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NullLockFactory c : NullLockFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NullLockFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

obtainLock

public Lock obtainLock(String identifier)

Obtain a lock for a resource identified by given identifier. Depending on the strategy, this method may return immediately or block until a lock is held.

This implementation does nothing.

Specified by:

obtainLock in interface LockFactory

Parameters:

identifier - the identifier of the resource to obtain a lock for.

Returns:

a handle to release the lock.