1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/rt/emul/compact/src/main/java/java/util/concurrent/locks/package-info.java Sat Mar 19 10:46:31 2016 +0100
1.3 @@ -0,0 +1,79 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.6 + *
1.7 + * This code is free software; you can redistribute it and/or modify it
1.8 + * under the terms of the GNU General Public License version 2 only, as
1.9 + * published by the Free Software Foundation. Oracle designates this
1.10 + * particular file as subject to the "Classpath" exception as provided
1.11 + * by Oracle in the LICENSE file that accompanied this code.
1.12 + *
1.13 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.14 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.15 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.16 + * version 2 for more details (a copy is included in the LICENSE file that
1.17 + * accompanied this code).
1.18 + *
1.19 + * You should have received a copy of the GNU General Public License version
1.20 + * 2 along with this work; if not, write to the Free Software Foundation,
1.21 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.22 + *
1.23 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.24 + * or visit www.oracle.com if you need additional information or have any
1.25 + * questions.
1.26 + */
1.27 +
1.28 +/*
1.29 + * This file is available under and governed by the GNU General Public
1.30 + * License version 2 only, as published by the Free Software Foundation.
1.31 + * However, the following notice accompanied the original version of this
1.32 + * file:
1.33 + *
1.34 + * Written by Doug Lea with assistance from members of JCP JSR-166
1.35 + * Expert Group and released to the public domain, as explained at
1.36 + * http://creativecommons.org/publicdomain/zero/1.0/
1.37 + */
1.38 +
1.39 +/**
1.40 + * Interfaces and classes providing a framework for locking and waiting
1.41 + * for conditions that is distinct from built-in synchronization and
1.42 + * monitors. The framework permits much greater flexibility in the use of
1.43 + * locks and conditions, at the expense of more awkward syntax.
1.44 + *
1.45 + * <p>The {@link java.util.concurrent.locks.Lock} interface supports
1.46 + * locking disciplines that differ in semantics (reentrant, fair, etc),
1.47 + * and that can be used in non-block-structured contexts including
1.48 + * hand-over-hand and lock reordering algorithms. The main implementation
1.49 + * is {@link java.util.concurrent.locks.ReentrantLock}.
1.50 + *
1.51 + * <p>The {@link java.util.concurrent.locks.ReadWriteLock} interface
1.52 + * similarly defines locks that may be shared among readers but are
1.53 + * exclusive to writers. Only a single implementation, {@link
1.54 + * java.util.concurrent.locks.ReentrantReadWriteLock}, is provided, since
1.55 + * it covers most standard usage contexts. But programmers may create
1.56 + * their own implementations to cover nonstandard requirements.
1.57 + *
1.58 + * <p>The {@link java.util.concurrent.locks.Condition} interface
1.59 + * describes condition variables that may be associated with Locks.
1.60 + * These are similar in usage to the implicit monitors accessed using
1.61 + * {@code Object.wait}, but offer extended capabilities.
1.62 + * In particular, multiple {@code Condition} objects may be associated
1.63 + * with a single {@code Lock}. To avoid compatibility issues, the
1.64 + * names of {@code Condition} methods are different from the
1.65 + * corresponding {@code Object} versions.
1.66 + *
1.67 + * <p>The {@link java.util.concurrent.locks.AbstractQueuedSynchronizer}
1.68 + * class serves as a useful superclass for defining locks and other
1.69 + * synchronizers that rely on queuing blocked threads. The {@link
1.70 + * java.util.concurrent.locks.AbstractQueuedLongSynchronizer} class
1.71 + * provides the same functionality but extends support to 64 bits of
1.72 + * synchronization state. Both extend class {@link
1.73 + * java.util.concurrent.locks.AbstractOwnableSynchronizer}, a simple
1.74 + * class that helps record the thread currently holding exclusive
1.75 + * synchronization. The {@link java.util.concurrent.locks.LockSupport}
1.76 + * class provides lower-level blocking and unblocking support that is
1.77 + * useful for those developers implementing their own customized lock
1.78 + * classes.
1.79 + *
1.80 + * @since 1.5
1.81 + */
1.82 +package java.util.concurrent.locks;