WhiteboardParticipantState.java

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.service.protocol;

/**
 * The WhiteboardParticipantState class reflects the current state of a
 * whiteboard participant.
 *
 * @author Julien Waechter
 * @author Emil Ivov
 */
public class WhiteboardParticipantState
{
    /**
     * This constant value indicates a String representation of the UNKNOWN
     * whiteboard state.
     * <br>This constant has the String value "Unknown".
     */
    public static final String _UNKNOWN = "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.
     */
    public static final WhiteboardParticipantState UNKNOWN =
                                      new WhiteboardParticipantState(_UNKNOWN);

    /**
     * This constant value indicates a String representation of the
     * INITIATING_WHITEBOARD whiteboard state.
     * <br>This constant has the String value "Initiating Whiteboard".
     */
    public static final String _INITIATING_WHITEBOARD = "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.
     */
    public static final WhiteboardParticipantState INITIATING_WHITEBOARD =
                        new WhiteboardParticipantState(_INITIATING_WHITEBOARD);

    /**
     * This constant value indicates a String representation of the CONNECTING
     * whiteboard state.
     * <br>This constant has the String value "Connecting".
     */
    public static final String _CONNECTING      = "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.
     */
    public static final WhiteboardParticipantState CONNECTING =
                                    new WhiteboardParticipantState(_CONNECTING);

    /**
     * This constant value indicates a String representation of the
     * INCOMING_WHITEBOARD whiteboard state.
     * <br>This constant has the String value "Incoming Whiteboard".
     */
    public static final String _INCOMING_WHITEBOARD    = "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).
     */
    public static final WhiteboardParticipantState INCOMING_WHITEBOARD
                         = new WhiteboardParticipantState(_INCOMING_WHITEBOARD);

    /**
     * This constant value indicates a String representation of the CONNECTED
     * whiteboard state.
     * <br>This constant has the String value "Connected".
     */
    public static final String _CONNECTED       = "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.
     */
    public static final WhiteboardParticipantState CONNECTED
                                  = new WhiteboardParticipantState(_CONNECTED);

    /**
     * This constant value indicates a String representation of the
     * DISCONNECTED whiteboard state.
     * <br>This constant has the String value "Disconnected".
     */
    public static final String _DISCONNECTED    = "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.
     */
    public static final WhiteboardParticipantState DISCONNECTED    =
                                  new WhiteboardParticipantState(_DISCONNECTED);

    /**
     * This constant value indicates a String representation of the BUSY
     * whiteboard state.
     * <br>This constant has the String value "Busy".
     */
    public static final String _BUSY            = "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).
     */
    public static final WhiteboardParticipantState BUSY
                                        = new WhiteboardParticipantState(_BUSY);

    /**
     * This constant value indicates a String representation of the FAILED
     * whiteboard state.
     * <br>This constant has the String value "Failed".
     */
    public static final String _FAILED          = "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.
     */
    public static final WhiteboardParticipantState FAILED
                                     = new WhiteboardParticipantState(_FAILED);


    /**
     * A string representationf this Participant Whiteboard State. Could be
     * _CONNECTED, _FAILED ....
     */
    private String whiteboardStateStr;

    /**
     * Create a participant whiteboard state object with a value corresponding
     * to the specified string.
     * @param whiteboardParticipantState a string representation of the state.
     */
    private WhiteboardParticipantState(String whiteboardParticipantState)
    {
        this.whiteboardStateStr = whiteboardParticipantState;
    }

    /**
     * Returns a String representation of tha WhiteboardParticipantSte.
     *
     * @return A string value (one of the _BUSY, _CONNECTED,  _CONNECTING,
     * _DISCONNECTED, _FAILED constants) representing
     * this whiteboard participant state).
     */
    public String getStateString()
    {
        return whiteboardStateStr;
    }

    /**
     * Returns a string represenation of this whiteboard state. Strings returned
     * by this method have the following format:
     * <p>
     * WhiteboardParticipantState:<STATE_STRING>
     * <p>
     * and are meant to be used for loggin/debugging purposes.
     *
     * @return a string representation of this object.
     */
    public String toString()
    {
        return getClass().getName()+":"+getStateString();
    }
}