Package com.codingchili.core.protocol

Class RoleMap

java.lang.Object

com.codingchili.core.protocol.RoleMap

public class RoleMap
extends Object

Add custom roles to the rolemap, must be done before initializing protocols. By mapping the name of the role to an instance annotations are no longer limited to the default roles in #Role.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADMIN
static String	PUBLIC
static String	UNSET
static String	USER

Constructor Summary

Constructors

Constructor	Description
RoleMap()

Method Summary

Modifier and Type	Method	Description
static RoleType	get(String name)	retrieves a role by its name.
static RoleType[]	get(String... names)
static void	put(String name, RoleType role)	Adds a role mapping.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ADMIN

public static final String ADMIN

See Also:

Constant Field Values

USER

public static final String USER

See Also:

Constant Field Values

PUBLIC

public static final String PUBLIC

See Also:

Constant Field Values

UNSET

public static final String UNSET

See Also:

Constant Field Values

Constructor Details

RoleMap

public RoleMap()

Method Details

put

public static void put(String name,
 RoleType role)

Adds a role mapping.

Parameters:

name - the name of the role.

role - the role implementation.

get

public static RoleType get(String name)

retrieves a role by its name.

Parameters:

name - the name of the role to retrieve.

Returns:

a registered role that matches the given name, throws an exception if the role is not registered.

get

public static RoleType[] get(String... names)

Parameters:

names - multiple names to retrieve the roles for.

Returns:

a list of roles that matches the given list. Throws an exception if any of the roles in the given names is not registered.