ml.alternet.concurrent.Mutex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alternet-tools Show documentation

Alternet Tools include discovery service tools, concurrent and locking tools, and more

The newest version!

package ml.alternet.concurrent;

/**
 * A mutex, based on a string ID, safe for synchronization for a given user
 * context.
 * 
 * Usage
 * 
 *  *    MutextContext mutexContext = new MutextContext();
 *    ...
 *    
 *    String id = someObject.getCanonicalID();
 *    Mutex mutex = mutexContext.getMutex(id);
 *    synchronized(mutex) {
 *       ...
 *    }
 * 
 * 
 * Instead of synchronizing on a Mutex it is also possible to get a
 * lock (exist in several flavours)
 * 
 * @see MutexContext
 * @see MutexContext#getLock(String)
 * @see MutexContext#getReadWriteLock(String)
 * @see MutexContext#getStampedLock(String)
 * 
 * @author Philippe Poulard
 */
public class Mutex {

    private final String id;

    Mutex(String id) {
        this.id = id;
    }

    @Override
    public boolean equals(Object o) {
        if (o == null) {
            return false;
        }
        if (this.getClass() == o.getClass()) {
            return this.id.equals(o.toString());
        }
        return false;
    }

    @Override
    public int hashCode() {
        return this.id.hashCode();
    }

    @Override
    public String toString() {
        return this.id;
    }

}