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.commons.configuration;
18
19 import org.apache.commons.configuration.reloading.Reloadable;
20
21 /**
22 * <p>A base class for hierarchical configurations with specific reloading
23 * requirements.</p>
24 * <p>This class manages a lock object which can be used for synchronization.</p>
25 *
26 * @author <a
27 * href="http://commons.apache.org/configuration/team-list.html">Commons
28 * Configuration team</a>
29 * @since 1.7
30 * @version $Id: HierarchicalReloadableConfiguration.java 1210000 2011-12-03 20:43:38Z oheger $
31 */
32 public class HierarchicalReloadableConfiguration extends HierarchicalConfiguration
33 implements Reloadable
34 {
35 /** Constant for the name used for the lock object. */
36 private static final String LOCK_NAME = "HierarchicalReloadableConfigurationLock";
37
38 /** The lock object used by this instance. */
39 private final Object reloadLock;
40
41 /**
42 * Creates a new instance of {@code HierarchicalReloadableConfiguration}.
43 */
44 public HierarchicalReloadableConfiguration()
45 {
46 super();
47 reloadLock = new Lock(LOCK_NAME);
48 }
49
50 /**
51 * Creates a new instance of {@code HierarchicalReloadableConfiguration} and
52 * initializes it with the given lock object.
53 *
54 * @param lock the lock object
55 */
56 public HierarchicalReloadableConfiguration(Object lock)
57 {
58 super();
59 reloadLock = lock == null ? new Lock(LOCK_NAME) : lock;
60 }
61
62 /**
63 * Creates a new instance of {@code HierarchicalReloadableConfiguration} and
64 * copies all data contained in the specified configuration into the new
65 * one.
66 *
67 * @param c the configuration that is to be copied (if <b>null</b>, this
68 * constructor will behave like the standard constructor)
69 */
70 public HierarchicalReloadableConfiguration(HierarchicalConfiguration c)
71 {
72 super(c);
73 reloadLock = new Lock(LOCK_NAME);
74 }
75
76 @Override
77 public Object getReloadLock()
78 {
79 return reloadLock;
80 }
81 }