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 * https://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.commons.configuration2.sync;
18
19 /**
20 * Enumerates how an object is locked for {@link SynchronizerSupport}.
21 * <p>
22 * The {@code SynchronizerSupport} interface allows locking an object. This can be done in different ways controlling
23 * the level of concurrency still possible with the object. One of the constants defined here can be passed in when
24 * calling the {@code lock()} method of a {@code SynchronizerSupport} object. (Note that at the end of the day it is up
25 * to a concrete implementation of {@link Synchronizer} how these lock modes are interpreted.)
26 * </p>
27 *
28 * @since 2.0
29 */
30 public enum LockMode {
31
32 /**
33 * Lock mode <em>READ</em>. The object is accessed in a read-only manner. Typically, this means that other read locks
34 * can be granted while concurrent writes are not permitted.
35 */
36 READ,
37
38 /**
39 * Lock mode <em>WRITE</em>. The object is updated. This usually means that this object is exclusively locked. Attempts
40 * of other readers or writers will block until the current update operation is complete.
41 */
42 WRITE
43 }