io.debezium.util.FunctionalReadWriteLock Maven / Gradle / Ivy

Go to download
/*
 * Copyright Debezium Authors.
 *
 * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package io.debezium.util;

import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import java.util.function.Supplier;

/**
 * A form of a read-write lock that has methods that allow lambdas to be performed while the read or write lock is acquired and
 * held.
 *
 * @author Randall Hauch
 */
public class FunctionalReadWriteLock {

    /**
     * Create a read-write lock that supports reentrancy.
     * @return the functional read-write lock; never null
     */
    public static FunctionalReadWriteLock reentrant() {
        return create(new ReentrantReadWriteLock());
    }

    /**
     * Create a read-write lock around the given standard {@link ReadWriteLock}.
     * @param lock the standard lock; may not be null
     * @return the functional read-write lock; never null
     */
    public static FunctionalReadWriteLock create(ReadWriteLock lock) {
        assert lock != null;
        return new FunctionalReadWriteLock(lock);
    }

    private final ReadWriteLock lock;

    protected FunctionalReadWriteLock(ReadWriteLock lock) {
        this.lock = lock;
    }

    /**
     * Obtain a read lock, perform the operation, and release the read lock.
     *
     * @param operation the operation to perform while the read lock is held; may not be null
     * @return the result of the operation
     */
    public  T read(Supplier operation) {
        try {
            lock.readLock().lock();
            return operation.get();
        }
        finally {
            lock.readLock().unlock();
        }
    }

    /**
     * Obtain a read lock, perform the operation, and release the lock.
     *
     * @param operation the operation to perform while the read lock is held; may not be null
     */
    public void read(Runnable operation) {
        try {
            lock.readLock().lock();
            operation.run();
        }
        finally {
            lock.readLock().unlock();
        }
    }

    /**
     * Obtain an exclusive write lock, perform the operation, and release the lock.
     *
     * @param operation the operation to perform while the write lock is held; may not be null
     * @return the result of the operation
     */
    public  T write(Supplier operation) {
        try {
            lock.writeLock().lock();
            return operation.get();
        }
        finally {
            lock.writeLock().unlock();
        }
    }

    /**
     * Obtain an exclusive write lock, perform the operation, and release the lock.
     *
     * @param operation the operation to perform while the write lock is held; may not be null
     */
    public void write(Runnable operation) {
        try {
            lock.writeLock().lock();
            operation.run();
        }
        finally {
            lock.writeLock().unlock();
        }
    }
}