Enum Class ActorRole

java.lang.Object

java.lang.Enum<ActorRole>

de.gustavblass.fsu.fmi.roombooking.model.actor.ActorRole

All Implemented Interfaces:

Serializable, Comparable<ActorRole>, Constable

public enum ActorRole
extends Enum<ActorRole>

Classification of Actors by their position at FMI. Sorted by priority (descending):

• IT_ADMINISTRATOR
• DIRECTOR
• DEAN
• ADMINISTRATION
• PROFESSOR
• RESEARCH_ASSISTANT
• TECHNICAL_EMPLOYEE
• PHD_CANDIDATE
• STUDENT
• UNKNOWN

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMINISTRATION	Anyone privileged with the ActorAuthority.FACULTY_ADMINISTRATION.
DEAN	Dekanat member of the FMI.
DIRECTOR	Director (head) of the Institute of Computer Science at the FMI.
IT_ADMINISTRATOR	Assigned to the most important Actors.
PHD_CANDIDATE	Person writing a doctoral dissertation in order to obtain a Doctor title.
PROFESSOR	University professors.
RESEARCH_ASSISTANT	See Wikipedia.
STUDENT	Regular university student.
TECHNICAL_EMPLOYEE	Associated with the ActorAuthority.PRIVILEGED.
UNKNOWN	Person not assigned any ActorRole.

Field Summary

Fields

Modifier and Type	Field	Description
final String	role

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ActorRole(@NonNull String role)

Method Summary

Modifier and Type	Method	Description
static @NonNull ActorRole	ofActorAuthority(@NonNull ActorAuthority actorAuthority)	Of those ActorRoles that correspond to the given ActorAuthority, returns that role with the lowest level of authority.
static @NonNull Optional<ActorRole>	ofName(String name)	Converts the given label to the matching enum value.
@NonNull ActorAuthority	toActorAuthority()	Converts this ActorRole to its corresponding ActorAuthority:
@NonNull org.springframework.security.core.GrantedAuthority	toGrantedAuthority()	Creates a new SimpleGrantedAuthority by prepending ROLE_ to the toActorAuthority() result.
static ActorRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActorRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IT_ADMINISTRATOR

public static final ActorRole IT_ADMINISTRATOR

Assigned to the most important Actors. Associated with the ActorAuthority.IT_ADMINISTRATION.

DEAN

public static final ActorRole DEAN

Dekanat member of the FMI.

DIRECTOR

public static final ActorRole DIRECTOR

Director (head) of the Institute of Computer Science at the FMI.

ADMINISTRATION

public static final ActorRole ADMINISTRATION

Anyone privileged with the ActorAuthority.FACULTY_ADMINISTRATION.

PROFESSOR

public static final ActorRole PROFESSOR

University professors. Associated with the ActorAuthority.PRIVILEGED.

RESEARCH_ASSISTANT

public static final ActorRole RESEARCH_ASSISTANT

See Wikipedia. Associated with the ActorAuthority.PRIVILEGED.

TECHNICAL_EMPLOYEE

public static final ActorRole TECHNICAL_EMPLOYEE

Associated with the ActorAuthority.PRIVILEGED.

PHD_CANDIDATE

public static final ActorRole PHD_CANDIDATE

Person writing a doctoral dissertation in order to obtain a Doctor title. Associated with the ActorAuthority.PRIVILEGED.

STUDENT

public static final ActorRole STUDENT

Regular university student. Associated with the ActorAuthority.REGULAR.

UNKNOWN

public static final ActorRole UNKNOWN

Person not assigned any ActorRole. Associated with the ActorAuthority.REGULAR.

Field Details

role

public final String role

Constructor Details

ActorRole

private ActorRole(@NonNull
 @NonNull String role)

Method Details

values

public static ActorRole[] 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 ActorRole 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

toActorAuthority

@Contract(pure=true)
@NonNull
public @NonNull ActorAuthority toActorAuthority()

Converts this ActorRole to its corresponding ActorAuthority:

• STUDENT, UNKNOWN: ActorAuthority.REGULAR
• everyone else: ActorAuthority.PRIVILEGED

Returns:

The ActorAuthority associated with this ActorRole.

toGrantedAuthority

@Contract(pure=true)
@NonNull
public @NonNull org.springframework.security.core.GrantedAuthority toGrantedAuthority()

Creates a new SimpleGrantedAuthority by prepending ROLE_ to the toActorAuthority() result. This tells the Spring framework that the GrantedAuthority is a role (see the documentation).

Returns:

The GrantedAuthority representing this role.

ofName

@Contract(pure=true)
@NonNull
public static @NonNull Optional<ActorRole> ofName(String name)

Converts the given label to the matching enum value.

Parameters:

name - A String suspected to be an enum value.

Returns:

The corresponding enum value if the given label matches one.

ofActorAuthority

@Contract(pure=true)
@NonNull
public static @NonNull ActorRole ofActorAuthority(@NonNull
 @NonNull ActorAuthority actorAuthority)

Of those ActorRoles that correspond to the given ActorAuthority, returns that role with the lowest level of authority.

Parameters:

actorAuthority - The authority for which to return an example role.

Returns:

An example role for the given authority.