aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/protocol/zeroconf/ZeroconfStatusEnum.java
blob: 3fe27456f155137e7244276a13a481605515e3bf (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
/*
 * 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.impl.protocol.zeroconf;

import java.util.*;

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

/**
 * An implementation of <tt>PresenceStatus</tt> that enumerates all states that
 * a Zeroconf contact can fall into.
 *
 * @author Christian Vincenot
 * @author Jonathan Martin
 */
public class ZeroconfStatusEnum
    extends PresenceStatus
{

    /**
     * Indicates an Offline status or status with 0 connectivity.
     */
    public static final ZeroconfStatusEnum OFFLINE
        = new ZeroconfStatusEnum(
            0,
            "Offline",
            ProtocolIconZeroconfImpl.getImageInBytes(
                "service.protocol.zeroconf.OFFLINE_STATUS_ICON"));

    /**
     * The DND status. Indicates that the user has connectivity but prefers
     * not to be contacted.
     */
    public static final ZeroconfStatusEnum DO_NOT_DISTURB
        = new ZeroconfStatusEnum(
            30,
            "Do Not Disturb",//, "Do Not Disturb",
            ProtocolIconZeroconfImpl.getImageInBytes(
                "service.protocol.zeroconf.DND_STATUS_ICON"));

    /**
     * The Invisible status. Indicates that the user has connectivity even
     * though it may appear otherwise to others, to whom she would appear to be
     * offline.
     */
    public static final ZeroconfStatusEnum INVISIBLE
        = new ZeroconfStatusEnum(
            45,
            "Invisible",
            ProtocolIconZeroconfImpl.getImageInBytes(
                "service.protocol.zeroconf.INVISIBLE_STATUS_ICON"));

    /**
     * The Online status. Indicate that the user is able and willing to
     * communicate.
     */
    public static final ZeroconfStatusEnum ONLINE
        = new ZeroconfStatusEnum(
            65,
            "Available",//, "Online"
            ProtocolIconZeroconfImpl.getImageInBytes(
                "service.protocol.zeroconf.ONLINE_STATUS_ICON"));


    /**
     * Initialize the list of supported status states.
     */
    private static List<PresenceStatus> supportedStatusSet = new LinkedList<PresenceStatus>();
    static
    {
        supportedStatusSet.add(OFFLINE);
        supportedStatusSet.add(DO_NOT_DISTURB);

        /* INVISIBLE STATUS could be supported by unregistering JmDNS and
         * accepting unknown contacts' messages */
        //supportedStatusSet.add(INVISIBLE);

        supportedStatusSet.add(ONLINE);
    }

    /**
     * Creates an instance of <tt>ZeroconfPresneceStatus</tt> with the
     * specified parameters.
     * @param status the connectivity level of the new presence status instance
     * @param statusName the name of the presence status.
     * @param statusIcon the icon associated with this status
     */
    private ZeroconfStatusEnum(int status,
                                String statusName,
                                byte[] statusIcon)
    {
        super(status, statusName, statusIcon);
    }

    /**
     * Returns an iterator over all status instances supproted by the zeroconf
     * provider.
     * @return an <tt>Iterator</tt> over all status instances supported by the
     * zeroconf provider.
     */
    static Iterator<PresenceStatus> supportedStatusSet()
    {
        return supportedStatusSet.iterator();
    }

    /**
     * @param status String representation of the status
     * @return ZeroconfStatusEnum corresponding the supplied String value
     */
    static ZeroconfStatusEnum statusOf(String status)
    {
        Iterator<PresenceStatus> statusIter = supportedStatusSet();
        while (statusIter.hasNext())
        {
            ZeroconfStatusEnum state = (ZeroconfStatusEnum)statusIter.next();
            if (state.statusName.equalsIgnoreCase(status))
                return state;
        }
        return null;
    }
}