com.unboundid.ldap.sdk.unboundidds

Enum AlertSeverity

java.lang.Object

java.lang.Enum<AlertSeverity>

com.unboundid.ldap.sdk.unboundidds.AlertSeverity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlertSeverity>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum AlertSeverity
extends java.lang.Enum<AlertSeverity>

This class provides information about the types of alert severities that may be included in alert entries.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR The alert severity that indicates that the associated alert indicates a non-fatal error has occurred.
FATAL The alert severity that indicates that the associated alert indicates a fatal error has occurred.
INFO The alert severity that indicates that the associated alert is informational.
WARNING The alert severity that indicates that the associated alert indicates a warning has occurred.

Method Summary

Modifier and Type	Method and Description
static AlertSeverity	forName(java.lang.String name) Retrieves the alert severity with the specified name.
java.lang.String	getName() Retrieves the name for this alert severity.
java.lang.String	toString() Retrieves a string representation of this alert severity.
static AlertSeverity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AlertSeverity[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INFO

public static final AlertSeverity INFO

The alert severity that indicates that the associated alert is informational.

WARNING

public static final AlertSeverity WARNING

The alert severity that indicates that the associated alert indicates a warning has occurred.

ERROR

public static final AlertSeverity ERROR

The alert severity that indicates that the associated alert indicates a non-fatal error has occurred.

FATAL

public static final AlertSeverity FATAL

The alert severity that indicates that the associated alert indicates a fatal error has occurred.

Method Detail

values

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

Returns:

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

valueOf

public static AlertSeverity valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this alert severity.

Returns:

The name for this alert severity.

forName

@Nullable
public static AlertSeverity forName(@NotNull
                                              java.lang.String name)

Retrieves the alert severity with the specified name.

Parameters:

name - The name of the alert severity to retrieve.

Returns:

The alert severity with the specified name, or null if there is no alert severity with the given name.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this alert severity.

Overrides:

toString in class java.lang.Enum<AlertSeverity>

Returns:

A string representation of this alert severity.