org.apache.ambari.server.state.alert

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

org.apache.ambari.server.state.alert.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

The Scope enumeration is used to define the area that an alert has the most meaning. This is primary used as a way for a UI to determine the correct views that the alert should be visible in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY The alert can be shown in any context (HOST or SERVICE).
HOST The alert only makes sense when viewing a host that the alert runs on.
SERVICE The alert only makes sense when viewing a service that the alert is defined for.

Method Summary

Modifier and Type	Method and Description
static Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

HOST

public static final Scope HOST

The alert only makes sense when viewing a host that the alert runs on.

SERVICE

public static final Scope SERVICE

The alert only makes sense when viewing a service that the alert is defined for.

ANY

public static final Scope ANY

The alert can be shown in any context (HOST or SERVICE).

Method Detail

values

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

Returns:

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

valueOf

public static Scope 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