net.java.sip.communicator.service.protocol.icqconstants
Class IcqStatusEnum

java.lang.Object
  net.java.sip.communicator.service.protocol.PresenceStatus
      net.java.sip.communicator.service.protocol.icqconstants.IcqStatusEnum

All Implemented Interfaces:

Comparable<PresenceStatus>

public class IcqStatusEnum
extends PresenceStatus

An enumeration containing all status instances that MUST be supported by an implementation of the ICQ (Oscar) protocol. Implementations may support other forms of PresenceStatus but they MUST ALL support those enumerated here.

For testing purposes, this class also provides a List containing all of the status fields.

Author:

Emil Ivov

Field Summary

static IcqStatusEnum	AWAY The Away ICQ status.
static IcqStatusEnum	DO_NOT_DISTURB The DND ICQ status.
static IcqStatusEnum	FREE_FOR_CHAT The Free For Chat ICQ status.
static ArrayList<IcqStatusEnum>	icqStatusSet The minimal set of states that any ICQ implementation must support.
static IcqStatusEnum	INVISIBLE The Invisible ICQ status.
static IcqStatusEnum	NOT_AVAILABLE The Not Available ICQ status.
static IcqStatusEnum	OCCUPIED The Occupied ICQ status.
static IcqStatusEnum	OFFLINE The Offline ICQ status.
static IcqStatusEnum	ONLINE The Online ICQ status.

Fields inherited from class net.java.sip.communicator.service.protocol.PresenceStatus

AVAILABLE_THRESHOLD, AWAY_THRESHOLD, EAGER_TO_COMMUNICATE_THRESHOLD, MAX_STATUS_VALUE, ONLINE_THRESHOLD, status, statusIcon, statusName

Constructor Summary

protected

IcqStatusEnum(int status, String statusName, byte[] statusIcon) Creates a status with the specified connectivity coeff, name and icon.

Method Summary

static byte[]

loadIcon(String imagePath) Loads an image from a given image path.

Methods inherited from class net.java.sip.communicator.service.protocol.PresenceStatus

compareTo, equals, getStatus, getStatusIcon, getStatusName, hashCode, isAvailable, isEagerToCommunicate, isOnline, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FREE_FOR_CHAT

public static final IcqStatusEnum FREE_FOR_CHAT

The Free For Chat ICQ status. Indicates that the user is eager to communicate.

ONLINE

public static final IcqStatusEnum ONLINE

The Online ICQ status. Indicate that the user is able and willing to communicate.

AWAY

public static final IcqStatusEnum AWAY

The Away ICQ status. Indicates that the user has connectivity but might not be able to immediately act upon initiation of communication.

INVISIBLE

public static final IcqStatusEnum INVISIBLE

The Invisible ICQ status. Indicates that the user has connectivity even though it may appear otherwise to others, to whom she would appear to be offline.

NOT_AVAILABLE

public static final IcqStatusEnum NOT_AVAILABLE

The Not Available ICQ status. Indicates that the user has connectivity but might not be able to immediately act (i.e. even less immediately than when in an Away status ;-P ) upon initiation of communication.

DO_NOT_DISTURB

public static final IcqStatusEnum DO_NOT_DISTURB

The DND ICQ status. Indicates that the user has connectivity but prefers not to be contacted.

OCCUPIED

public static final IcqStatusEnum OCCUPIED

The Occupied ICQ status. Indicates that the user has connectivity and communication is particularly unwanted.

OFFLINE

public static final IcqStatusEnum OFFLINE

The Offline ICQ status. Indicates the user does not seem to be connected to the ICQ network or at least does not want us to know she is

icqStatusSet

public static final ArrayList<IcqStatusEnum> icqStatusSet

The minimal set of states that any ICQ implementation must support.

Constructor Detail

IcqStatusEnum

protected IcqStatusEnum(int status,
                        String statusName,
                        byte[] statusIcon)

Creates a status with the specified connectivity coeff, name and icon.

Parameters:

status - the connectivity coefficient for the specified status

statusName - String

statusIcon - the icon associated with this status

Method Detail

loadIcon

public static byte[] loadIcon(String imagePath)

Loads an image from a given image path.

Parameters:

imagePath - The identifier of the image.

Returns:

The image for the given identifier.