1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.util;
import java.io.Serial;
import java.util.Collection;
import java.util.HashSet;
import org.apache.tomcat.util.res.StringManager;
/**
* Extended implementation of <strong>HashSet</strong> that includes a <code>locked</code> property. This class can be
* used to safely expose resource path sets to user classes without having to clone them in order to avoid
* modifications. When first created, a <code>ResourceMap</code> is not locked.
*
* @param <T> The type of elements in the Set
*
* @author Craig R. McClanahan
*/
public final class ResourceSet<T> extends HashSet<T> {
@Serial
private static final long serialVersionUID = 1L;
// ----------------------------------------------------------- Constructors
/**
* Construct a new, empty set with the default initial capacity and load factor.
*/
public ResourceSet() {
super();
}
/**
* Construct a new, empty set with the specified initial capacity and default load factor.
*
* @param initialCapacity The initial capacity of this set
*/
public ResourceSet(int initialCapacity) {
super(initialCapacity);
}
/**
* Construct a new, empty set with the specified initial capacity and load factor.
*
* @param initialCapacity The initial capacity of this set
* @param loadFactor The load factor of this set
*/
public ResourceSet(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Construct a new set with the same contents as the existing collection.
*
* @param coll The collection whose contents we should copy
*/
public ResourceSet(Collection<T> coll) {
super(coll);
}
// ------------------------------------------------------------- Properties
/**
* The current lock state of this parameter map.
*/
private boolean locked = false;
/**
* @return the locked state of this parameter map.
*/
public boolean isLocked() {
return this.locked;
}
/**
* Set the locked state of this parameter map.
*
* @param locked The new locked state
*/
public void setLocked(boolean locked) {
this.locked = locked;
}
/**
* The string manager for this package.
*/
private static final StringManager sm = StringManager.getManager("org.apache.catalina.util");
// --------------------------------------------------------- Public Methods
/**
* {@inheritDoc}
*
* @exception IllegalStateException if this set is currently locked
*/
@Override
public boolean add(T o) {
if (locked) {
throw new IllegalStateException(sm.getString("resourceSet.locked"));
}
return super.add(o);
}
/**
* {@inheritDoc}
*
* @exception IllegalStateException if this set is currently locked
*/
@Override
public void clear() {
if (locked) {
throw new IllegalStateException(sm.getString("resourceSet.locked"));
}
super.clear();
}
/**
* {@inheritDoc}
*
* @exception IllegalStateException if this set is currently locked
*/
@Override
public boolean remove(Object o) {
if (locked) {
throw new IllegalStateException(sm.getString("resourceSet.locked"));
}
return super.remove(o);
}
}
|
