Status.Code

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.google.enterprise.adaptor
Enum Status.Code

java.lang.Object
  java.lang.Enum<Status.Code>
      com.google.enterprise.adaptor.Status.Code

All Implemented Interfaces:: Serializable, Comparable<Status.Code>

Enclosing interface:: Status

public static enum Status.Code
extends Enum<Status.Code>
extends Enum<Status.Code>

Available statuses for displaying state indicators on the dashboard.

Enum Constant Summary
`ERROR` There is a known problem; user intervention is likely needed to resolve the problem.
`INACTIVE` The status is disabled because it does not apply.
`NORMAL` Everything is go; all is right with the world.
`UNAVAILABLE` The status is enabled but was unable to be resolved.
`WARNING` There may be a problem, but maybe not; user intervention may aid the situation, but things may fix themselves.

Method Summary
`static Status.Code`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Status.Code[]`	`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

INACTIVE

public static final Status.Code INACTIVE

The status is disabled because it does not apply. Assumably the feature it monitors is disabled.

Represented with an empty LED.

UNAVAILABLE

public static final Status.Code UNAVAILABLE

The status is enabled but was unable to be resolved. This is not an error, but simply a "we don't know yet" state. Consider a status that pings a machine to make sure it is alive and the network is up. While the very first ping is in progress "unavailable" would be the most appropriate status.

Represented with an empty LED.

NORMAL

public static final Status.Code NORMAL

Everything is go; all is right with the world.

Represented with a green LED.

WARNING

public static final Status.Code WARNING

There may be a problem, but maybe not; user intervention may aid the situation, but things may fix themselves. Alternatively, a user can't do anything to improve the situation, but they need to be aware that it is occuring.

Represented with a yellow LED.

ERROR

public static final Status.Code ERROR

There is a known problem; user intervention is likely needed to resolve the problem.

Represented with a red LED.

Method Detail

values

public static Status.Code[] 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 (Status.Code c : Status.Code.values())
    System.out.println(c);

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

valueOf

public static Status.Code 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