1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.juneau.commons.concurrent;
18
19 import java.util.concurrent.locks.*;
20
21 /**
22 * An extension of {@link ReentrantReadWriteLock} with convenience methods for creating
23 * auto-closeable locks.
24 */
25 public class SimpleReadWriteLock extends ReentrantReadWriteLock {
26 private static final long serialVersionUID = 1L;
27 /**
28 * A no-op lock.
29 */
30 public static SimpleReadWriteLock NO_OP = new SimpleReadWriteLock() {
31 private static final long serialVersionUID = 1L;
32
33 @Override
34 public SimpleLock read() {
35 return SimpleLock.NO_OP;
36 }
37
38 @Override
39 public SimpleLock write() {
40 return SimpleLock.NO_OP;
41 }
42 };
43
44 /**
45 * Constructor.
46 */
47 public SimpleReadWriteLock() {}
48
49 /**
50 * Constructor
51 *
52 * @param fair <jk>true</jk> if this lock should use a fair ordering policy.
53 */
54 public SimpleReadWriteLock(boolean fair) {
55 super(fair);
56 }
57
58 /**
59 * Construct a read lock.
60 *
61 * @return A new closeable read lock.
62 */
63 public SimpleLock read() {
64 return new SimpleLock(readLock());
65 }
66
67 /**
68 * Construct a write lock.
69 *
70 * @return A new closeable write lock.
71 */
72 public SimpleLock write() {
73 return new SimpleLock(writeLock());
74 }
75 }