net.java.otr4j.session

Enum SessionStatus

java.lang.Object

java.lang.Enum<SessionStatus>

net.java.otr4j.session.SessionStatus

All Implemented Interfaces:

Serializable, Comparable<SessionStatus>

public enum SessionStatus
extends Enum<SessionStatus>

Author:

George Politis

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCRYPTED This state indicates that outgoing messages are sent encrypted.
FINISHED This state indicates that outgoing messages are not delivered at all.
PLAINTEXT This state indicates that outgoing messages are sent without encryption.

Method Summary

Modifier and Type	Method and Description
static SessionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static SessionStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PLAINTEXT

public static final SessionStatus PLAINTEXT

This state indicates that outgoing messages are sent without encryption. This is the state that is used before an OTR conversation is initiated. This is the initial state, and the only way to subsequently enter this state is for the user to explicitly request to do so via some UI operation.

ENCRYPTED

public static final SessionStatus ENCRYPTED

This state indicates that outgoing messages are sent encrypted. This is the state that is used during an OTR conversation. The only way to enter this state is for the authentication state machine to successfully complete.

FINISHED

public static final SessionStatus FINISHED

This state indicates that outgoing messages are not delivered at all. This state is entered only when the other party indicates he has terminated his side of the OTR conversation.

Method Detail

values

public static SessionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SessionStatus c : SessionStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SessionStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null