Package com.btcvelocity.api.permission

Interface PermissionResolver

All Superinterfaces:

PermissionFunction

All Known Implementing Classes:

PermissionResolverFunctionAdapter

public interface PermissionResolver
extends PermissionFunction

An extension of PermissionFunction that allows the implementation of some more complex methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final PermissionResolver	ALWAYS_FALSE	A simple permission resolver adapter backed by PermissionFunction.ALWAYS_FALSE.
static final PermissionResolver	ALWAYS_TRUE	A simple permission resolver adapter backed by PermissionFunction.ALWAYS_TRUE.
static final PermissionResolver	ALWAYS_UNDEFINED	A simple permission resolver adapter backed by PermissionFunction.ALWAYS_UNDEFINED.

Method Summary

Modifier and Type	Method	Description
@Nullable @Unmodifiable Map<String,Boolean>	getPermissionMap()	Gets the subjects permission map.
@NonNull Tristate	getPermissionValue(String permission)	Gets the subjects setting for a particular permission.

Field Details

ALWAYS_TRUE

static final PermissionResolver ALWAYS_TRUE

A simple permission resolver adapter backed by PermissionFunction.ALWAYS_TRUE.

ALWAYS_FALSE

static final PermissionResolver ALWAYS_FALSE

A simple permission resolver adapter backed by PermissionFunction.ALWAYS_FALSE.

ALWAYS_UNDEFINED

static final PermissionResolver ALWAYS_UNDEFINED

A simple permission resolver adapter backed by PermissionFunction.ALWAYS_UNDEFINED.

Method Details

getPermissionValue

@NonNull Tristate getPermissionValue(String permission)

Gets the subjects setting for a particular permission.

Specified by:

getPermissionValue in interface PermissionFunction

Parameters:

permission - the permission

Returns:

the value the permission is set to

getPermissionMap

@Nullable @Unmodifiable Map<String,Boolean> getPermissionMap()

Gets the subjects permission map. Should return null when the permission map is unavailable.

Returns:

the permission map or null if unavailable