com.starteam.viewcomparemerge
Class Session.State

java.lang.Object
  com.starteam.viewcomparemerge.Session.State

Enclosing class:

Session

public static final class Session.State
extends java.lang.Object

The state of the sesion. A session may be in one and only one of these states at any given time.

Field Summary

static Session.State[]	ALL All possible session states
static Session.State	CLOSED Session.close() has been called, so all intermediate results; e.g.
static Session.State	COMMITTED New and restored sessions have this state if commit() was successfully called (hence cannot be called again).
static Session.State	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 Session.State	CONNECTED A session has this state before compare() has been called.
static Session.State	DISCONNECTED A session is in this state when it has been restored (from a serialized stream) but not yet connected.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DISCONNECTED

public static final Session.State DISCONNECTED

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

CONNECTED

public static final Session.State 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 Session.State 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 Session.State 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 Session.State 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.

ALL

public static final Session.State[] ALL

All possible session states

Method Detail

equals

public boolean equals(java.lang.Object o)

returns true if the two SessionStates represent the same state

Overrides:

equals in class java.lang.Object

Parameters:

o - State a State to test for equality

Returns:

boolean true if the two SessionStates are equal

hashCode

public int hashCode()

returns hashcode of the session state

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode

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