aboutsummaryrefslogtreecommitdiff
path: root/src/com/wilko/jaim/responses/BuddyUpdateTocResponse.java
blob: 1d791980e868bfef9aebfabe6b9e5f148ed16f30 (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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/*
 *   (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
 *
 */

/*
 * BuddyUpdateTocResponse.java
 *
 * Created on 5 May 2002, 21:19
 */

package com.wilko.jaim.responses;

import com.wilko.jaim.JaimEventListener;

import java.util.Date;
import java.util.StringTokenizer;

/**
 * A BuddyUpdateTocResponse is delivered to a {@link JaimEventListener } when a buddy update is received from the TOC server
 *
 * @author paulw
 * @version $Revision: 1.7 $
 */
public class BuddyUpdateTocResponse extends TocResponse implements TocResponseHandler {

    public static String RESPONSE_TYPE = "UPDATE_BUDDY";
    private String buddyName;
    private boolean online;
    private int evil;
    private int idleTime;
    private boolean onAOL;
    private boolean unconfirmed;
    private boolean admin;
    private boolean confirmed;
    private Date signonTime;
    private boolean away;

    /**
     * Creates new BuddyUpdateTocResponse
     */
    public BuddyUpdateTocResponse() {
        buddyName = "";
        online = false;
        evil = 0;
        idleTime = 0;
        onAOL = false;
        unconfirmed = false;
        admin = false;
        confirmed = false;
        away = false;
    }

    /**
     * The parseString method is used to populate the fields of this class from a Buddy Update string from the TOC server
     *
     * @param str The String containing the buddy update
     */
    public TocResponse parseString(java.lang.String str) {
        BuddyUpdateTocResponse tr = new BuddyUpdateTocResponse();
        tr.doParse(str);
        return (tr);
    }

    private void doParse(String str) {
        cmd = str;
        StringTokenizer st = new StringTokenizer(str, ":");

        st.nextToken();
        buddyName = st.nextToken();
        String onlineStr = st.nextToken();
        online = onlineStr.equals("T");

        evil = Integer.parseInt(st.nextToken());
        long signon = Long.parseLong(st.nextToken());
        signonTime = new Date(signon * 1000);
        idleTime = Integer.parseInt(st.nextToken());
        String userclass = st.nextToken();
        if (userclass.charAt(0) == 'A')
            onAOL = true;
        if (userclass.charAt(1) == 'A') {
            admin = true;
        } else {
            if (userclass.charAt(1) == 'U') {
                unconfirmed = true;
            } else {
                if (userclass.charAt(1) == 'O') {
                    confirmed = true;
                }
            }
        }
        if (userclass.length() > 2) {
            if (userclass.charAt(2) == 'U') {
                away = true;
            }
        }
    }

    /**
     * Get the away status of the buddy specified by this update
     *
     * @return true if the buddy is "away"
     */
    public boolean isAway() {
        return (away);
    }

    /**
     * Get the response type of  this response.  This method is used by the response dispatcher within JaimConnection
     *
     * @return The response type
     */
    public String getResponseType() {
        return RESPONSE_TYPE;
    }

    /**
     * Obtain the buddy name from this update
     *
     * @return The buddy name
     */
    public String getBuddy() {
        return (buddyName);
    }

    /**
     * Obtain the online status of this buddy update
     *
     * @return true if the buddy is on line
     */
    public boolean isOnline() {
        return (online);
    }

    /**
     * Obtain the idle time of this buddy
     *
     * @return The idle time in seconds
     */
    public int getIdleTime() {
        return (idleTime);
    }

    /**
     * Obtain the "Evil" (Warning) level of this buddy
     *
     * @return The warning level as a percentage
     */
    public int getEvil() {
        return (evil);
    }

    /**
     * Is this buddy an "Administrator"
     *
     * @return true if an administrator
     */
    public boolean isAdmin() {
        return (admin);
    }

    /**
     * IS this buddy a "confirmed" user
     *
     * @return True if this buddy is confirmed
     */
    public boolean isConfirmed() {
        return (confirmed);
    }

    /**
     * Is this user an "Unconfirmed user"
     *
     * @return True if this user is unconfirmed
     */
    public boolean isUnconfirmed() {
        return (unconfirmed);
    }

    /**
     * Get the signon time of this buddy
     *
     * @return The date/time of signon
     */
    public Date getSignonTime() {
        return (signonTime);
    }

    /**
     * Returns true if this response handler can handle the specified response.
     *
     * @param Response - the response string from TOC.  This is the part of the response before the first ':'
     * @return true if the response can be handled
     */
    public boolean canHandle(String Response) {
        return (Response.equalsIgnoreCase(RESPONSE_TYPE));
    }

}