ElvisCommStatus

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> synaptics >> [ elvis overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.synaptics.elvis.ElvisCommStatus

SOURCE |

Download com.synaptics.elvis.ElvisCommStatus

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.synaptics.elvis
Class ElvisCommStatus

java.lang.Object
  com.synaptics.elvis.ElvisCommStatus

final class ElvisCommStatus
extends java.lang.Object

ElvisCommStatus implements an enumeration of the various statuses than an ElvisComm may have. See the individual statuses for details of what they do.

ElvisCommStatus is private to the elvis package, and should never be put in a position to be directly seen by clients. However, each status has a string associated with it that is more or less descriptive of the status. It is quite practical to pass this String to Elvis clients.

ElvisCommStatus implements the typesafe enum design pattern, as described in Joshua Bloch's Effective Java.

Version:: $Id: ElvisCommStatus.java,v 1.1 2002/05/09 07:17:17 clheiny Exp $

Field Summary

static ElvisCommStatus CHECKING
          We are looking to see if another Elvis might exist on this machine.

static ElvisCommStatus CONNECTING
          There might be another Elvis, and we are trying to contact him.

static ElvisCommStatus FAILED
          We failed miserably in setting up the listener.

private static java.util.Hashtable knownStatus
          We keep a list of valid statuses here for checking.

static ElvisCommStatus LOCKING
          Are in the process of locking the authentication information file.

(package private) java.lang.String name
          This is the string associated with this status.

static ElvisCommStatus NEW
          This instance has been created but not started.

static ElvisCommStatus NO_RESPONSE
          The other Elvis did not send a reasonable response.

static ElvisCommStatus NOT_THE_KING
          There is another Elvis, he responded correctly, so we will be asking him to handle all performance requests.

static ElvisCommStatus OK
          Indicates that we are the One True Elvis, and are waiting for a request.

static ElvisCommStatus PROCESSING
          Indicates that we are the One True Elvis, and are handling a request.

static ElvisCommStatus TIMEOUT
          We timed out waiting for the other Elvis to respond to us.

Constructor Summary

private ElvisCommStatus(java.lang.String name)
          Creates new ElvisCommStatus

Method Summary

java.lang.String toString()
          Get the String associated with the status.

static boolean valid(java.lang.String name)


Methods inherited from class java.lang.Object

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

Field Detail

knownStatus

private static java.util.Hashtable knownStatus

We keep a list of valid statuses here for checking.

OK

public static final ElvisCommStatus OK

Indicates that we are the One True Elvis, and are waiting for a request.

PROCESSING

public static final ElvisCommStatus PROCESSING

Indicates that we are the One True Elvis, and are handling a request.

LOCKING

public static final ElvisCommStatus LOCKING

Are in the process of locking the authentication information file.

NEW

public static final ElvisCommStatus NEW

This instance has been created but not started. You must call @link #start() to do that.

CHECKING

public static final ElvisCommStatus CHECKING

We are looking to see if another Elvis might exist on this machine.

CONNECTING

public static final ElvisCommStatus CONNECTING

There might be another Elvis, and we are trying to contact him.

FAILED

public static final ElvisCommStatus FAILED

We failed miserably in setting up the listener. The fans might as well go home.

TIMEOUT

public static final ElvisCommStatus TIMEOUT

We timed out waiting for the other Elvis to respond to us.

NO_RESPONSE

public static final ElvisCommStatus NO_RESPONSE

The other Elvis did not send a reasonable response.

NOT_THE_KING

public static final ElvisCommStatus NOT_THE_KING

There is another Elvis, he responded correctly, so we will be asking him to handle all performance requests.

name

java.lang.String name

This is the string associated with this status. We initialize it to "ERROR" just in case something strange happens.

Constructor Detail