aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/service/muc/ChatRoomPresenceStatus.java
blob: b0d81a815fd1c9cfc90a2f9b2e30ef7ed3f26d5a (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
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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 net.java.sip.communicator.service.muc;

import net.java.sip.communicator.service.protocol.*;

/**
 * The chat room statuses.
 * 
 * @author Hristo Terezov
 */
public class ChatRoomPresenceStatus extends PresenceStatus
{
    /**
     * An integer above which all values of the status coefficient indicate
     * eagerness to communicate
     */
    public static final int CHAT_ROOM_ONLINE_THRESHOLD = 86;
    
    /**
     * An integer above which all values of the status coefficient indicate
     * eagerness to communicate
     */
    public static final int CHAT_ROOM_OFFLINE_THRESHOLD = 87;
    
    /**
     * Indicates that the user is connected and ready to communicate.
     */
    public static final String ONLINE_STATUS = "Online";

    /**
     * Indicates that the user is disconnected.
     */
    public static final String OFFLINE_STATUS = "Offline";
    
    /**
     * The Online status. Indicate that the user is able and willing to
     * communicate in the chat room.
     */
    public static final ChatRoomPresenceStatus CHAT_ROOM_ONLINE
        = new ChatRoomPresenceStatus(
                86,
                ONLINE_STATUS);

    /**
     * The Offline  status. Indicates the user does not seem to be connected
     * to the chat room.
     */
    public static final ChatRoomPresenceStatus CHAT_ROOM_OFFLINE
        = new ChatRoomPresenceStatus(
                87,
                OFFLINE_STATUS);
    
    /**
     * Creates a status with the specified connectivity coeff and name for the 
     * chat rooms.
     * @param status the connectivity coefficient for the specified status
     * @param statusName String
     */
    protected ChatRoomPresenceStatus(int status, String statusName)
    {
        super(status, statusName);
    }
    
    @Override
    public boolean isOnline()
    {
        return getStatus() == CHAT_ROOM_ONLINE_THRESHOLD;
    }
    
}