aboutsummaryrefslogtreecommitdiff
path: root/src/com/wilko/jaim/Group.java
blob: 5adcdbe08f8a99ea03cb6d2a6e01920a7eb2d822 (plain)
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
/*
 *   (C) 2002 Paul Wilkinson  wilko@users.sourceforge.net
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

/*
 * Group.java
 *
 * Created on 4 May 2002, 12:05
 */

package com.wilko.jaim;

import java.util.Enumeration;
import java.util.Vector;

/**
 * This is a logical user group.  It holds a set of users.
 *
 * @author Brett Humphreys
 */
public class Group {

    /**
     * Vector of buddies for this group
     */
    private final Vector buddies = new Vector();

    /**
     * Name of this group
     */
    private final String groupName;

    /**
     * This constructor sets the name of the group
     *
     * @param name the group name
     */
    public Group(String name) {
        groupName = name;
    }

    /**
     * This method adds a buddy to the end of the group
     *
     * @param buddy The buddy object to associate with this group
     */
    public void addBuddy(Buddy buddy) {
        buddies.add(buddy);
    }

    /**
     * This method adds a buddy to the specified location in the group
     * If the specified location is beyond the end of the group, then the buddy is added to the end of the group
     *
     * @param buddy The buddy object to associate with this group
     * @param pos   the position to add the buddy
     */
    public void addBuddy(Buddy buddy, int pos) {
        if (pos > buddies.size()) {
            buddies.add(buddy);
        } else {
            buddies.add(pos, buddy);
        }
    }

    /**
     * This method gets the group name
     *
     * @return the group name
     */
    public String getName() {
        return groupName;
    }

    /**
     * This method returns the buddies in this group
     *
     * @return an Enumeration of {@link Buddy} objects
     */
    public Enumeration enumerateBuddies() {
        return buddies.elements();
    }

    /**
     * This method returns the number of buddies in this group
     *
     * @return buddy count
     */
    public int getBuddyCount() {
        return (buddies.size());
    }

    /**
     * This method returns the buddies in this group
     *
     * @return a Collection of {@link Buddy} objects
     */
    public java.util.Collection getBuddies() {
        java.util.Collection cReturn = new java.util.Vector(buddies);
        return cReturn;
    }

}