%line | %branch | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
org.apache.turbine.util.security.GroupSet |
|
|
1 | package org.apache.turbine.util.security; |
|
2 | ||
3 | /* |
|
4 | * Copyright 2001-2005 The Apache Software Foundation. |
|
5 | * |
|
6 | * Licensed under the Apache License, Version 2.0 (the "License") |
|
7 | * you may not use this file except in compliance with the License. |
|
8 | * You may obtain a copy of the License at |
|
9 | * |
|
10 | * http://www.apache.org/licenses/LICENSE-2.0 |
|
11 | * |
|
12 | * Unless required by applicable law or agreed to in writing, software |
|
13 | * distributed under the License is distributed on an "AS IS" BASIS, |
|
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
15 | * See the License for the specific language governing permissions and |
|
16 | * limitations under the License. |
|
17 | */ |
|
18 | ||
19 | import java.util.Collection; |
|
20 | import java.util.Iterator; |
|
21 | ||
22 | import org.apache.commons.lang.StringUtils; |
|
23 | ||
24 | import org.apache.turbine.om.security.Group; |
|
25 | ||
26 | /** |
|
27 | * This class represents a set of Groups. It's useful for building |
|
28 | * administration UI. It enforces that only |
|
29 | * Group objects are allowed in the set and only relevant methods |
|
30 | * are available. |
|
31 | * |
|
32 | * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a> |
|
33 | * @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a> |
|
34 | * @author <a href="mailto:marco@intermeta.de">Marco Knüttel</a> |
|
35 | * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a> |
|
36 | * @version $Id: GroupSet.java 278822 2005-09-05 19:53:05Z henning $ |
|
37 | */ |
|
38 | public class GroupSet |
|
39 | extends SecuritySet |
|
40 | { |
|
41 | /** Serial Version UID */ |
|
42 | private static final long serialVersionUID = 34735375738993720L; |
|
43 | ||
44 | /** |
|
45 | * Constructs an empty GroupSet |
|
46 | */ |
|
47 | public GroupSet() |
|
48 | { |
|
49 | 0 | super(); |
50 | 0 | } |
51 | ||
52 | /** |
|
53 | * Constructs a new GroupSet with specified contents. |
|
54 | * |
|
55 | * If the given collection contains multiple objects that are |
|
56 | * identical WRT equals() method, some objects will be overwritten. |
|
57 | * |
|
58 | * @param groups A collection of groups to be contained in the set. |
|
59 | */ |
|
60 | public GroupSet(Collection groups) |
|
61 | { |
|
62 | 100 | super(); |
63 | 100 | add(groups); |
64 | 100 | } |
65 | ||
66 | /** |
|
67 | * Adds a Group to this GroupSet. |
|
68 | * |
|
69 | * @param group A Group. |
|
70 | * @return True if Group was added; false if GroupSet |
|
71 | * already contained the Group. |
|
72 | */ |
|
73 | public boolean add(Group group) |
|
74 | { |
|
75 | 222 | boolean res = contains(group); |
76 | 222 | nameMap.put(group.getName(), group); |
77 | 222 | idMap.put(group.getIdAsObj(), group); |
78 | 222 | return res; |
79 | } |
|
80 | ||
81 | /** |
|
82 | * Adds the Groups in a Collection to this GroupSet. |
|
83 | * |
|
84 | * @param groups A Collection of Groups. |
|
85 | * @return True if this GroupSet changed as a result; false |
|
86 | * if no change to this GroupSet occurred (this GroupSet |
|
87 | * already contained all members of the added GroupSet). |
|
88 | */ |
|
89 | public boolean add(Collection groups) |
|
90 | { |
|
91 | 100 | boolean res = false; |
92 | 259 | for (Iterator it = groups.iterator(); it.hasNext();) |
93 | { |
|
94 | 218 | Group g = (Group) it.next(); |
95 | 218 | res |= add(g); |
96 | } |
|
97 | 100 | return res; |
98 | } |
|
99 | ||
100 | /** |
|
101 | * Adds the Groups in another GroupSet to this GroupSet. |
|
102 | * |
|
103 | * @param groupSet A GroupSet. |
|
104 | * @return True if this GroupSet changed as a result; false |
|
105 | * if no change to this GroupSet occurred (this GroupSet |
|
106 | * already contained all members of the added GroupSet). |
|
107 | */ |
|
108 | public boolean add(GroupSet groupSet) |
|
109 | { |
|
110 | 0 | boolean res = false; |
111 | 0 | for( Iterator it = groupSet.iterator(); it.hasNext();) |
112 | { |
|
113 | 0 | Group g = (Group) it.next(); |
114 | 0 | res |= add(g); |
115 | } |
|
116 | 0 | return res; |
117 | } |
|
118 | ||
119 | /** |
|
120 | * Removes a Group from this GroupSet. |
|
121 | * |
|
122 | * @param group A Group. |
|
123 | * @return True if this GroupSet contained the Group |
|
124 | * before it was removed. |
|
125 | */ |
|
126 | public boolean remove(Group group) |
|
127 | { |
|
128 | 2 | boolean res = contains(group); |
129 | 2 | nameMap.remove(group.getName()); |
130 | 2 | idMap.remove(group.getIdAsObj()); |
131 | 2 | return res; |
132 | } |
|
133 | ||
134 | /** |
|
135 | * Checks whether this GroupSet contains a Group. |
|
136 | * |
|
137 | * @param group A Group. |
|
138 | * @return True if this GroupSet contains the Group, |
|
139 | * false otherwise. |
|
140 | */ |
|
141 | public boolean contains(Group group) |
|
142 | { |
|
143 | 224 | return nameMap.containsValue((Object) group); |
144 | } |
|
145 | ||
146 | /** |
|
147 | * Returns a Group with the given name, if it is contained in |
|
148 | * this GroupSet. |
|
149 | * |
|
150 | * @param groupName Name of Group. |
|
151 | * @return Group if argument matched a Group in this |
|
152 | * GroupSet; null if no match. |
|
153 | * @deprecated Use <a href="#getGroupByName">getGroupByName</a> instead. |
|
154 | */ |
|
155 | public Group getGroup(String groupName) |
|
156 | { |
|
157 | 0 | return getGroupByName(groupName); |
158 | } |
|
159 | ||
160 | /** |
|
161 | * Returns a Group with the given name, if it is contained in |
|
162 | * this GroupSet. |
|
163 | * |
|
164 | * @param groupName Name of Group. |
|
165 | * @return Group if argument matched a Group in this |
|
166 | * GroupSet; null if no match. |
|
167 | */ |
|
168 | public Group getGroupByName(String groupName) |
|
169 | { |
|
170 | 62 | return (StringUtils.isNotEmpty(groupName)) |
171 | ? (Group) nameMap.get(groupName) : null; |
|
172 | } |
|
173 | ||
174 | /** |
|
175 | * Returns a Group with the given id, if it is contained in |
|
176 | * this GroupSet. |
|
177 | * |
|
178 | * @param groupId Id of the group |
|
179 | * @return Group if argument matched a Group in this |
|
180 | * GroupSet; null if no match. |
|
181 | */ |
|
182 | public Group getGroupById(int groupId) |
|
183 | { |
|
184 | 2 | return (groupId != 0) |
185 | ? (Group) idMap.get(new Integer(groupId)) : null; |
|
186 | } |
|
187 | ||
188 | /** |
|
189 | * Returns an Array of Groups in this GroupSet. |
|
190 | * |
|
191 | * @return An Array of Group objects. |
|
192 | */ |
|
193 | public Group[] getGroupsArray() |
|
194 | { |
|
195 | 0 | return (Group[]) getSet().toArray(new Group[0]); |
196 | } |
|
197 | ||
198 | /** |
|
199 | * Print out a GroupSet as a String |
|
200 | * |
|
201 | * @returns The Group Set as String |
|
202 | * |
|
203 | */ |
|
204 | public String toString() |
|
205 | { |
|
206 | 0 | StringBuffer sb = new StringBuffer(); |
207 | 0 | sb.append("GroupSet: "); |
208 | ||
209 | 0 | for(Iterator it = iterator(); it.hasNext();) |
210 | { |
|
211 | 0 | Group g = (Group) it.next(); |
212 | 0 | sb.append('['); |
213 | 0 | sb.append(g.getName()); |
214 | 0 | sb.append(" -> "); |
215 | 0 | sb.append(g.getIdAsObj()); |
216 | 0 | sb.append(']'); |
217 | 0 | if (it.hasNext()) |
218 | { |
|
219 | 0 | sb.append(", "); |
220 | } |
|
221 | } |
|
222 | ||
223 | 0 | return sb.toString(); |
224 | } |
|
225 | } |
This report is generated by jcoverage, Maven and Maven JCoverage Plugin. |