com.starbase.starteam.viewcomparemerge
Class SessionState

java.lang.Object
  |
  +--com.starbase.starteam.viewcomparemerge.SessionState

public final class SessionState

extends java.lang.Object

An enumeration of states. A session may be in one and only one of these states at any given time.

Field Summary

static SessionState	CLOSED Session.close() has been called, so all intermediate results; e.g.
static SessionState	COMMITTED New and restored sessions have this state if commit() was successfully called (hence cannot be called again).
static SessionState	COMPARED New and/or restored sessions have this state if compare() successfully completed (hence cannot be called again), but commit() was never successfully called.
static SessionState	CONNECTED A session has this state before compare() has been called.
static SessionState	DISCONNECTED A session is in this state when it has been restored (from a serialized stream) but not yet connected.

Method Summary

boolean	equals(SessionState theOther) returns true if the two SessionStates represent the same state
java.lang.String	getName() Returns the name of this session state as a string.
java.lang.String	toString() Returns a String representation of this session state

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DISCONNECTED

public static final SessionState DISCONNECTED

A session is in this state when it has been restored (from a serialized stream) but not yet connected.

CONNECTED

public static final SessionState CONNECTED

A session has this state before compare() has been called. A restored session has this state (if connected) and if compare() was never successfully called before it was saved.

COMPARED

public static final SessionState COMPARED

New and/or restored sessions have this state if compare() successfully completed (hence cannot be called again), but commit() was never successfully called.

COMMITTED

public static final SessionState COMMITTED

New and restored sessions have this state if commit() was successfully called (hence cannot be called again). Generating the "update report" is about all that can be done.

CLOSED

public static final SessionState CLOSED

Session.close() has been called, so all intermediate results; e.g. system resources, private workspaces, etc. have been deleted. Nothing else can be done with the session.

Method Detail

equals

public boolean equals(SessionState theOther)

returns true if the two SessionStates represent the same state

Parameters:

theOther - SessionState a SessionState to test for equality

Returns:

boolean true if the two SessionStates are equal

getName

public java.lang.String getName()

Returns the name of this session state as a string.

Returns:

the name of this session state as a string.

toString

public java.lang.String toString()

Returns a String representation of this session state

Overrides:

toString in class java.lang.Object

Returns:

String a String representation of this session state