source code formatting.
[utils] / security / src / main / java / org / wamblee / usermgt / Group.java
1 /*
2  * Copyright 2005 the original author or authors.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.usermgt;
17
18 import org.wamblee.persistence.AbstractPersistent;
19
20 import java.io.Serializable;
21
22
23 /**
24  * Represents a group.
25  *
26  * @author Erik Brakkee
27  */
28 public class Group extends AbstractPersistent implements Serializable,
29     Comparable {
30     /**
31      * Group name.
32      */
33     private String name;
34
35 /**
36      * Constructs the group. 
37      * @param aName
38      */
39     Group(String aName) {
40         super();
41         name = aName;
42     }
43
44 /**
45      * Creates a new Group object.
46      *
47      * @param aGroup DOCUMENT ME!
48      */
49     public Group(Group aGroup) {
50         super(aGroup);
51         name = aGroup.name;
52     }
53
54 /**
55      * Creates a new Group object.
56      */
57     protected Group() {
58         super();
59         name = null;
60     }
61
62     /**
63      * Gets the name of the group.
64      *
65      * @return Group name.
66      */
67     public String getName() {
68         return name;
69     }
70
71     /**
72      * Sets the group name.
73      *
74      * @param aName Group name.
75      */
76     void setName(String aName) {
77         name = aName;
78     }
79
80     /* (non-Javadoc)
81      * @see java.lang.Object#equals(java.lang.Object)
82      */
83     /**
84      * DOCUMENT ME!
85      *
86      * @param aGroup DOCUMENT ME!
87      *
88      * @return DOCUMENT ME!
89      */
90     @Override
91     public boolean equals(Object aGroup) {
92         if (!(aGroup instanceof Group)) {
93             return false;
94         }
95
96         return name.equals(((Group) aGroup).name);
97     }
98
99     /* (non-Javadoc)
100      * @see java.lang.Object#hashCode()
101      */
102     /**
103      * DOCUMENT ME!
104      *
105      * @return DOCUMENT ME!
106      */
107     @Override
108     public int hashCode() {
109         return name.hashCode();
110     }
111
112     /* (non-Javadoc)
113      * @see java.lang.Comparable#compareTo(T)
114      */
115     /**
116      * DOCUMENT ME!
117      *
118      * @param aGroup DOCUMENT ME!
119      *
120      * @return DOCUMENT ME!
121      */
122     public int compareTo(Object aGroup) {
123         return name.compareTo(((Group) aGroup).name);
124     }
125
126     /* (non-Javadoc)
127      * @see java.lang.Object#toString()
128      */
129     /**
130      * DOCUMENT ME!
131      *
132      * @return DOCUMENT ME!
133      */
134     @Override
135     public String toString() {
136         return "Group(pk = " + getPrimaryKey() + ", name=" + name + ")";
137     }
138 }