org.eclipse.jetty.util.thread.Locker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.util.thread;

import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.ReentrantLock;

/**
 *  Convenience auto closeable {@link java.util.concurrent.locks.ReentrantLock} wrapper.
 *
 *   *  try (Locker.Lock lock = locker.lock())
 *  {
 *    // something
 *  }
 *  
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
public class Locker {

    private final ReentrantLock _lock = new ReentrantLock();

    private final Lock _unlock = new Lock();

    /**
     * Acquires the lock.
     *
     * @return the lock to unlock
     */
    public Lock lock() {
        _lock.lock();
        return _unlock;
    }

    /**
     * @return the lock to unlock
     * @deprecated use {@link #lock()} instead
     */
    @Deprecated
    public Lock lockIfNotHeld() {
        return lock();
    }

    /**
     * @return whether this lock has been acquired
     */
    public boolean isLocked() {
        return _lock.isLocked();
    }

    /**
     * @return a {@link Condition} associated with this lock
     */
    public Condition newCondition() {
        return _lock.newCondition();
    }

    /**
     *  The unlocker object that unlocks when it is closed.
     *
     * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
     */
    @Deprecated(since = "2021-05-27")
    public class Lock implements AutoCloseable {

        @Override
        public void close() {
            _lock.unlock();
        }
    }

    @Deprecated
    public class UnLock extends Lock {
    }
}