net.java.sip.communicator.service.protocol
Class WhiteboardParticipantState

java.lang.Object
  net.java.sip.communicator.service.protocol.WhiteboardParticipantState

public class WhiteboardParticipantState
extends Object

The WhiteboardParticipantState class reflects the current state of a whiteboard participant.

Author:

Julien Waechter, Emil Ivov

Field Summary

static String	_BUSY This constant value indicates a String representation of the BUSY whiteboard state.
static String	_CONNECTED This constant value indicates a String representation of the CONNECTED whiteboard state.
static String	_CONNECTING This constant value indicates a String representation of the CONNECTING whiteboard state.
static String	_DISCONNECTED This constant value indicates a String representation of the DISCONNECTED whiteboard state.
static String	_FAILED This constant value indicates a String representation of the FAILED whiteboard state.
static String	_INCOMING_WHITEBOARD This constant value indicates a String representation of the INCOMING_WHITEBOARD whiteboard state.
static String	_INITIATING_WHITEBOARD This constant value indicates a String representation of the INITIATING_WHITEBOARD whiteboard state.
static String	_UNKNOWN This constant value indicates a String representation of the UNKNOWN whiteboard state.
static WhiteboardParticipantState	BUSY This constant value indicates that the state of the whiteboard participant is is BUSY - which means that an attempt to establish a whiteboard with that participant has been made and that it has been turned down by them (e.g.
static WhiteboardParticipantState	CONNECTED This constant value indicates that the state of the whiteboard participant is is CONNECTED - which means that there is an ongoing whiteboard with that participant.
static WhiteboardParticipantState	CONNECTING This constant value indicates that the state of the whiteboard participant is is CONNECTING - which means that a network connection to that participant is currently being established.
static WhiteboardParticipantState	DISCONNECTED This constant value indicates that the state of the whiteboard participant is is DISCONNECTET - which means that this participant is not participating :) in the whiteboard any more.
static WhiteboardParticipantState	FAILED This constant value indicates that the state of the whiteboard participant is is ON_HOLD - which means that an attempt to establish a whiteboard with that participant has failed for an unexpected reason.
static WhiteboardParticipantState	INCOMING_WHITEBOARD This constant value indicates that the state of the whiteboard participant is is INCOMING_WHITEBOARD - which means that the participant is willing to start a whiteboard with us.
static WhiteboardParticipantState	INITIATING_WHITEBOARD This constant value indicates that the state of the whiteboard participant is is INITIATING_WHITEBOARD - which means that we're currently trying to open a socket and send our request.
static WhiteboardParticipantState	UNKNOWN This constant value indicates that the state of the whiteboard participant is is UNKNOWN - which means that there is no information on the state for the time being (this constant should be used as a default value for newly created whiteboard participant that don't yet have an attributed whiteboard state.

Method Summary

String	getStateString() Returns a String representation of tha WhiteboardParticipantSte.
String	toString() Returns a string represenation of this whiteboard state.

Methods inherited from class java.lang.Object

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

Field Detail

_UNKNOWN

public static final String _UNKNOWN

This constant value indicates a String representation of the UNKNOWN whiteboard state.
This constant has the String value "Unknown".

See Also:

Constant Field Values

UNKNOWN

public static final WhiteboardParticipantState UNKNOWN

This constant value indicates that the state of the whiteboard participant is is UNKNOWN - which means that there is no information on the state for the time being (this constant should be used as a default value for newly created whiteboard participant that don't yet have an attributed whiteboard state.

_INITIATING_WHITEBOARD

public static final String _INITIATING_WHITEBOARD

This constant value indicates a String representation of the INITIATING_WHITEBOARD whiteboard state.
This constant has the String value "Initiating Whiteboard".

See Also:

Constant Field Values

INITIATING_WHITEBOARD

public static final WhiteboardParticipantState INITIATING_WHITEBOARD

This constant value indicates that the state of the whiteboard participant is is INITIATING_WHITEBOARD - which means that we're currently trying to open a socket and send our request. In the case of SIP for example we will leave this state the moment we receive a "100 Trying" request from a proxy or the remote side.

_CONNECTING

public static final String _CONNECTING

This constant value indicates a String representation of the CONNECTING whiteboard state.
This constant has the String value "Connecting".

See Also:

Constant Field Values

CONNECTING

public static final WhiteboardParticipantState CONNECTING

This constant value indicates that the state of the whiteboard participant is is CONNECTING - which means that a network connection to that participant is currently being established.

_INCOMING_WHITEBOARD

public static final String _INCOMING_WHITEBOARD

This constant value indicates a String representation of the INCOMING_WHITEBOARD whiteboard state.
This constant has the String value "Incoming Whiteboard".

See Also:

Constant Field Values

INCOMING_WHITEBOARD

public static final WhiteboardParticipantState INCOMING_WHITEBOARD

This constant value indicates that the state of the whiteboard participant is is INCOMING_WHITEBOARD - which means that the participant is willing to start a whiteboard with us. At that point local side should be playing a sound or a graphical alert (the phone is ringing).

_CONNECTED

public static final String _CONNECTED

This constant value indicates a String representation of the CONNECTED whiteboard state.
This constant has the String value "Connected".

See Also:

Constant Field Values

CONNECTED

public static final WhiteboardParticipantState CONNECTED

This constant value indicates that the state of the whiteboard participant is is CONNECTED - which means that there is an ongoing whiteboard with that participant.

_DISCONNECTED

public static final String _DISCONNECTED

This constant value indicates a String representation of the DISCONNECTED whiteboard state.
This constant has the String value "Disconnected".

See Also:

Constant Field Values

DISCONNECTED

public static final WhiteboardParticipantState DISCONNECTED

This constant value indicates that the state of the whiteboard participant is is DISCONNECTET - which means that this participant is not participating :) in the whiteboard any more.

_BUSY

public static final String _BUSY

This constant value indicates a String representation of the BUSY whiteboard state.
This constant has the String value "Busy".

See Also:

Constant Field Values

BUSY

public static final WhiteboardParticipantState BUSY

This constant value indicates that the state of the whiteboard participant is is BUSY - which means that an attempt to establish a whiteboard with that participant has been made and that it has been turned down by them (e.g. because they were already in a whiteboard).

_FAILED

public static final String _FAILED

This constant value indicates a String representation of the FAILED whiteboard state.
This constant has the String value "Failed".

See Also:

Constant Field Values

FAILED

public static final WhiteboardParticipantState FAILED

This constant value indicates that the state of the whiteboard participant is is ON_HOLD - which means that an attempt to establish a whiteboard with that participant has failed for an unexpected reason.

Method Detail

getStateString

public String getStateString()

Returns a String representation of tha WhiteboardParticipantSte.

Returns:

A string value (one of the _BUSY, _CONNECTED, _CONNECTING, _DISCONNECTED, _FAILED constants) representing this whiteboard participant state).

toString

public String toString()

Returns a string represenation of this whiteboard state. Strings returned by this method have the following format:

WhiteboardParticipantState:

and are meant to be used for loggin/debugging purposes.

Overrides:

toString in class Object

Returns:

a string representation of this object.