net.java.sip.communicator.service.protocol.msnconstants
Class MsnStatusEnum

java.lang.Object
  net.java.sip.communicator.service.protocol.PresenceStatus
      net.java.sip.communicator.service.protocol.msnconstants.MsnStatusEnum

All Implemented Interfaces:

Comparable<PresenceStatus>

public class MsnStatusEnum
extends PresenceStatus

An enumeration containing all status instances that MUST be supported by an implementation of the msn 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:

Damian Minkov

Field Summary

static MsnStatusEnum	AWAY The Away status.
static MsnStatusEnum	BE_RIGHT_BACK The Not Available status.
static MsnStatusEnum	BUSY The DND status.
static MsnStatusEnum	HIDE The Invisible status.
static MsnStatusEnum	IDLE The Idle status.
static ArrayList<MsnStatusEnum>	msnStatusSet The minimal set of states that any implementation must support.
static MsnStatusEnum	OFFLINE The Offline status.
static MsnStatusEnum	ON_THE_PHONE The On the phone status.
static MsnStatusEnum	ONLINE The Online status.
static MsnStatusEnum	OUT_TO_LUNCH The Out to lunch 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

MsnStatusEnum(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

ONLINE

public static final MsnStatusEnum ONLINE

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

AWAY

public static final MsnStatusEnum AWAY

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

IDLE

public static final MsnStatusEnum IDLE

The Idle status. Indicates that the user is not using the messanger.

HIDE

public static final MsnStatusEnum HIDE

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.

OUT_TO_LUNCH

public static final MsnStatusEnum OUT_TO_LUNCH

The Out to lunch status. Indicates that the user is eating.

BE_RIGHT_BACK

public static final MsnStatusEnum BE_RIGHT_BACK

The Not Available 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.

ON_THE_PHONE

public static final MsnStatusEnum ON_THE_PHONE

The On the phone status. Indicates that the user is talking to the phone.

BUSY

public static final MsnStatusEnum BUSY

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

OFFLINE

public static final MsnStatusEnum OFFLINE

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

msnStatusSet

public static final ArrayList<MsnStatusEnum> msnStatusSet

The minimal set of states that any implementation must support.

Constructor Detail

MsnStatusEnum

protected MsnStatusEnum(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.