net.java.sip.communicator.impl.protocol.sip
Class SipStatusEnum

java.lang.Object
  net.java.sip.communicator.impl.protocol.sip.SipStatusEnum

public class SipStatusEnum
extends Object

The SipStatusEnum gives access to presence states for the Sip protocol. All status icons corresponding to presence states are located with the help of the imagePath parameter

Author:

Emil Ivov, Yana Stamcheva

Field Summary

static String	AWAY The Away status.
static String	BUSY The busy status.
static String	OFFLINE Indicates an Offline status or status with 0 connectivity.
static String	ON_THE_PHONE The On the phone status.
static String	ONLINE The Online status.
List<PresenceStatus>	supportedStatusSet The supported status set stores all statuses supported by this protocol implementation.
static String	UNKNOWN The Unknown status.

Constructor Summary

SipStatusEnum(String iconPath)

Method Summary

net.java.sip.communicator.impl.protocol.sip.SipStatusEnum.SipPresenceStatus	getStatus(String statusName) Returns the offline sip status.
Iterator<PresenceStatus>	getSupportedStatusSet() Returns an iterator over all status instances supported by the sip provider.
static byte[]	loadIcon(String imagePath) Loads an image from a given image path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OFFLINE

public static final String OFFLINE

Indicates an Offline status or status with 0 connectivity.

See Also:

Constant Field Values

ONLINE

public static final String ONLINE

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

See Also:

Constant Field Values

BUSY

public static final String BUSY

The busy status. Indicates that the user has connectivity but is doing something else.

See Also:

Constant Field Values

ON_THE_PHONE

public static final String ON_THE_PHONE

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

See Also:

Constant Field Values

AWAY

public static final String AWAY

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

See Also:

Constant Field Values

UNKNOWN

public static final String UNKNOWN

The Unknown status. Indicate that we don't know if the user is present or not.

See Also:

Constant Field Values

supportedStatusSet

public final List<PresenceStatus> supportedStatusSet

The supported status set stores all statuses supported by this protocol implementation.

Constructor Detail

SipStatusEnum

public SipStatusEnum(String iconPath)

Method Detail

getStatus

public net.java.sip.communicator.impl.protocol.sip.SipStatusEnum.SipPresenceStatus getStatus(String statusName)

Returns the offline sip status.

Parameters:

statusName - the name of the status.

Returns:

the offline sip status.

getSupportedStatusSet

public Iterator<PresenceStatus> getSupportedStatusSet()

Returns an iterator over all status instances supported by the sip provider.

Returns:

an Iterator over all status instances supported by the sip provider.

loadIcon

public static byte[] loadIcon(String imagePath)

Loads an image from a given image path.

Parameters:

imagePath - The path to the image resource.

Returns:

The image extracted from the resource at the specified path.