X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=security%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fusermgt%2FGroupSet.java;h=33beb43a1e279460a11fb982efb9351b90955725;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=780d60bb72f8ff02464c44739093e535a17e4f74;hpb=92e23e5ecf9614f2ab770a8cdedc0b21ddf1e127;p=utils diff --git a/security/src/main/java/org/wamblee/usermgt/GroupSet.java b/security/src/main/java/org/wamblee/usermgt/GroupSet.java index 780d60bb..33beb43a 100644 --- a/security/src/main/java/org/wamblee/usermgt/GroupSet.java +++ b/security/src/main/java/org/wamblee/usermgt/GroupSet.java @@ -1,23 +1,23 @@ /* * Copyright 2005 the original author or authors. - * + * * Licensed 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.wamblee.usermgt; import java.util.Set; + /** * Represents a set of groups. A typical implemnetation would be, a readonly implementation * defined in a configuration file or a list of groups defined in a database. @@ -25,49 +25,72 @@ import java.util.Set; * @author Erik Brakkee */ public interface GroupSet { - /** - * Must be called when the group has been modified to notify the group set. - * @param aGroup Group that was modified. + * Must be called when the group has been modified to notify the + * group set. + * + * @param aGroup Group that was modified. */ - void groupModified(Group aGroup); - + void groupModified(Group aGroup); + /** - * Finds the group by name. - * @param aName Group name. - * @return Group or null if not found. + * Finds the group by name. + * + * @param aName Group name. + * + * @return Group or null if not found. */ Group find(String aName); - + /** - * Determines if the group exists. - * @param aGroup Group. - * @return True iff the group exists. + * Determines if the group exists. + * + * @param aGroup Group. + * + * @return True iff the group exists. */ boolean contains(Group aGroup); - + /** - * Adds a group. If the group already exists, the existing group set - * is left unchanged. + * Adds a group. If the group already exists, the existing group + * set is left unchanged. + * * @param aGroup Group. + * + * @return DOCUMENT ME! */ boolean add(Group aGroup); - + /** - * Removes a group. If the group does not exist, this method is a no-op. + * Removes a group. If the group does not exist, this method is a + * no-op. + * * @param aGroup Group to remove. - * @return True if the group was removed, false otherwise. + * + * @return True if the group was removed, false otherwise. */ boolean remove(Group aGroup); - + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ +/** * Returns the current groups. * @return Groups. */ Set list(); /** - * @return The number of groups. + * DOCUMENT ME! + * + * @return The number of groups. */ - int size(); + int size(); }