net.bolbat.kit.vo

Class LockingVO

java.lang.Object

net.bolbat.kit.vo.LockingVO

All Implemented Interfaces:

Serializable, Locking

Direct Known Subclasses:

LockingEntityVO

public class LockingVO
extends Object
implements Locking

Value object for handling locking state.
Can be used to control object immutability.
Example: LockingEntityVO.

Author:

Alexandr Bolbat

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LockingVO()

Method Summary

Modifier and Type	Method and Description
protected void	checkRead() Check is read operation, LockingReadException will be thrown if read not allowed.
protected void	checkWrite() Check is write operation, LockingWriteException will be thrown if write not allowed.
LockingState	getLockingState() Get LockingState.
boolean	isReadAllowed() Is read operation allowed.
boolean	isWriteAllowed() Is write operation allowed.
protected void	lock(boolean reads, boolean writes) Lock object with given configuration.
protected void	unlock() Unlock object for any operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

LockingVO

public LockingVO()

Method Detail

getLockingState

public LockingState getLockingState()

Description copied from interface: Locking

Get LockingState.

Specified by:

getLockingState in interface Locking

Returns:

LockingState

isReadAllowed

public boolean isReadAllowed()

Description copied from interface: Locking

Is read operation allowed.

Specified by:

isReadAllowed in interface Locking

Returns:

true if allowed or false

isWriteAllowed

public boolean isWriteAllowed()

Description copied from interface: Locking

Is write operation allowed.

Specified by:

isWriteAllowed in interface Locking

Returns:

true if allowed or false

checkRead

protected void checkRead()

Check is read operation, LockingReadException will be thrown if read not allowed.

checkWrite

protected void checkWrite()

Check is write operation, LockingWriteException will be thrown if write not allowed.

lock

protected void lock(boolean reads,
                    boolean writes)

Lock object with given configuration.

Parameters:

reads - is reads allowed

writes - is writes allowed

unlock

protected void unlock()

Unlock object for any operation.