Package com.developer.nefarious.zjoule.plugin.models

Enum Class Role

java.lang.Object

java.lang.Enum<Role>

com.developer.nefarious.zjoule.plugin.models.Role

All Implemented Interfaces:

Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>

Represents different roles in the system.

The Role enum defines three distinct roles:

• USER - Represents a standard user.
• ASSISTANT - Represents an assistant role.
• SYSTEM - Represents a system-level role.

Each role has an associated string value for serialization and display purposes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Role.RoleSerializer	Custom serializer for the Role enum to be used with Gson.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANT	Represents an assistant role.
SYSTEM	Represents a system-level role.
USER	Represents a standard user role.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Retrieves the string value associated with the role.
String	toString()	Returns the string representation of the role.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER

public static final Role USER

Represents a standard user role.

ASSISTANT

public static final Role ASSISTANT

Represents an assistant role.

SYSTEM

public static final Role SYSTEM

Represents a system-level role.

Method Details

values

public static Role[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Role valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Retrieves the string value associated with the role.

Returns:

the string value of the role.

toString

public String toString()

Returns the string representation of the role.

Overrides:

toString in class Enum<Role>

Returns:

the string value of the role.