com.helger.photon.basic.security.lock

Class LockResult<IDTYPE>

java.lang.Object

com.helger.photon.basic.security.lock.LockResult<IDTYPE>

Type Parameters:

IDTYPE - The type of the ID of the locked object.

All Implemented Interfaces:

ILockedIndicator

@Immutable
public final class LockResult<IDTYPE>
extends Object
implements ILockedIndicator

This class contains the result of a locking operation.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
LockResult(IDTYPE aObjID, ELocked eLocked, boolean bIsNewLock, List<IDTYPE> aUnlockedObjects)

Method Summary

Methods

Modifier and Type	Method and Description
static <IDTYPE> LockResult<IDTYPE>	createFailure(IDTYPE aObjID)
boolean	equals(Object o)
IDTYPE	getLockedObjectID()
List<IDTYPE>	getUnlockedObjects()
int	hashCode()
boolean	isLocked()
boolean	isNewLock()
boolean	isNotLocked()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LockResult

public LockResult(@Nonnull
          IDTYPE aObjID,
          @Nonnull
          ELocked eLocked,
          boolean bIsNewLock,
          @Nullable
          List<IDTYPE> aUnlockedObjects)

Method Detail

getLockedObjectID

@Nonnull
public IDTYPE getLockedObjectID()

Returns:

The ID of the locked object. Never null.

isLocked

public boolean isLocked()

Specified by:

isLocked in interface ILockedIndicator

Returns:

true if locked and false if not locked.

isNotLocked

public boolean isNotLocked()

Specified by:

isNotLocked in interface ILockedIndicator

Returns:

true if not locked and false if locked.

isNewLock

public boolean isNewLock()

Returns:

true if the lock was just created or false if the object was already locked.

getUnlockedObjects

@Nonnull
@ReturnsMutableCopy
public List<IDTYPE> getUnlockedObjects()

Returns:

A list with all objects that were unlocked during the locking process. Never null but maybe empty.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createFailure

@Nonnull
public static <IDTYPE> LockResult<IDTYPE> createFailure(@Nonnull
                                                IDTYPE aObjID)