Package com.btcvelocity.api.permission

Class PermissionResolverFunctionAdapter

java.lang.Object

com.btcvelocity.api.permission.PermissionResolverFunctionAdapter

All Implemented Interfaces:

PermissionResolver, PermissionFunction

public class PermissionResolverFunctionAdapter
extends Object
implements PermissionResolver

Adapter implementation of PermissionResolver backed by a PermissionFunction.

Permission checks are delegated to the provided PermissionFunction. Advanced/bulk operations are not supported by the backing API and therefore behave as no-ops, and/or returning null results.

Field Summary

Fields inherited from interface com.btcvelocity.api.permission.PermissionResolver

ALWAYS_FALSE, ALWAYS_TRUE, ALWAYS_UNDEFINED

Constructor Summary

Constructors

Constructor	Description
PermissionResolverFunctionAdapter(PermissionFunction permissionFunction)	Instantiates a PermissionResolverFunctionAdapter which delegates PermissionResolver.getPermissionValue(String) to permissionFunction#getPermissionValue(String).

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.

Methods inherited from class java.lang.Object

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

Constructor Details

PermissionResolverFunctionAdapter

public PermissionResolverFunctionAdapter(PermissionFunction permissionFunction)

Instantiates a PermissionResolverFunctionAdapter which delegates PermissionResolver.getPermissionValue(String) to permissionFunction#getPermissionValue(String).

Parameters:

permissionFunction - the PermissionFunction to use as a delegate.

Method Details

getPermissionValue

public @NonNull Tristate getPermissionValue(String permission)

Description copied from interface: PermissionResolver

Gets the subjects setting for a particular permission.

Specified by:

getPermissionValue in interface PermissionFunction

Specified by:

getPermissionValue in interface PermissionResolver

Parameters:

permission - the permission

Returns:

the value the permission is set to

getPermissionMap

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

Description copied from interface: PermissionResolver

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

Specified by:

getPermissionMap in interface PermissionResolver

Returns:

the permission map or null if unavailable