net.java.sip.communicator.service.protocol.yahooconstants
Class YahooStatusEnum

java.lang.Object
  net.java.sip.communicator.service.protocol.PresenceStatus
      net.java.sip.communicator.service.protocol.yahooconstants.YahooStatusEnum

All Implemented Interfaces:

Comparable<PresenceStatus>

public class YahooStatusEnum
extends PresenceStatus

An enumeration containing all status instances that MUST be supported by an implementation of the yahoo 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 YahooStatusEnum	AVAILABLE The Online status.
static YahooStatusEnum	BE_RIGHT_BACK The Not Available status.
static YahooStatusEnum	BUSY The DND status.
static YahooStatusEnum	IDLE The Idle status.
static YahooStatusEnum	INVISIBLE The Invisible status.
static YahooStatusEnum	NOT_AT_DESK The Not at desk status.
static YahooStatusEnum	NOT_AT_HOME The Not at home status.
static YahooStatusEnum	NOT_IN_OFFICE The Not in office status.
static YahooStatusEnum	OFFLINE The Offline status.
static YahooStatusEnum	ON_THE_PHONE The On the phone status.
static YahooStatusEnum	ON_VACATION The On vacation status.
static YahooStatusEnum	OUT_TO_LUNCH The Out to lunch status.
static YahooStatusEnum	STEPPED_OUT The STEPPED_OUT status.
static ArrayList<YahooStatusEnum>	yahooStatusSet The minimal set of states that any implementation must support.

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

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

AVAILABLE

public static final YahooStatusEnum AVAILABLE

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

BE_RIGHT_BACK

public static final YahooStatusEnum 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.

IDLE

public static final YahooStatusEnum IDLE

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

INVISIBLE

public static final YahooStatusEnum INVISIBLE

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.

STEPPED_OUT

public static final YahooStatusEnum STEPPED_OUT

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

OUT_TO_LUNCH

public static final YahooStatusEnum OUT_TO_LUNCH

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

NOT_AT_HOME

public static final YahooStatusEnum NOT_AT_HOME

The Not at home status. Indicates that the user is not at home.

NOT_AT_DESK

public static final YahooStatusEnum NOT_AT_DESK

The Not at desk status. Indicates that the user is not at his desk, but somewhere in the office.

NOT_IN_OFFICE

public static final YahooStatusEnum NOT_IN_OFFICE

The Not in office status. Indicates that the user is out of the office.

ON_VACATION

public static final YahooStatusEnum ON_VACATION

The On vacation status. Indicates that the user is somewhere on the beach or skiing.

ON_THE_PHONE

public static final YahooStatusEnum ON_THE_PHONE

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

BUSY

public static final YahooStatusEnum BUSY

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

OFFLINE

public static final YahooStatusEnum 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

yahooStatusSet

public static final ArrayList<YahooStatusEnum> yahooStatusSet

The minimal set of states that any implementation must support.

Constructor Detail

YahooStatusEnum

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