Role (OpenNMS 28.0.1 API)

java.lang.Object
- java.lang.Enum<Role>
- - org.opennms.features.distributed.coordination.api.Role

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Role>
```
public enum Role
extends java.lang.Enum<Role>
```
The valid roles when participating in a redundant cluster.

Enum Constant Summary

Enum Constants
Enum Constant Description

ACTIVE

STANDBY

UNKNOWN

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Role`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Role[]`	`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
  - UNKNOWN
```
public static final Role UNKNOWN
```
  - ACTIVE
```
public static final Role ACTIVE
```
  - STANDBY
```
public static final Role STANDBY
```
- Method Detail
  - values
```
public static Role[] 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 (Role c : Role.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Role 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