org.spongepowered.api.service.permission

Class MemorySubjectData

java.lang.Object

org.spongepowered.api.service.permission.MemorySubjectData

All Implemented Interfaces:

SubjectData

public class MemorySubjectData
extends Object
implements SubjectData

A subject data implementation storing all contained data in memory.

This class is thread-safe.

Field Summary

Fields inherited from interface org.spongepowered.api.service.permission.SubjectData

GLOBAL_CONTEXT

Constructor Summary

Constructors

Constructor and Description
MemorySubjectData(PermissionService service) Creates a new subject data instance, using the provided service to request instances of permission subjects.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	addParent(Set<Context> contexts, SubjectReference parent) Adds a parent in a particular context combination.
CompletableFuture<Boolean>	clearOptions() Clear all options.
CompletableFuture<Boolean>	clearOptions(Set<Context> contexts) Clear all options in the given context combination.
CompletableFuture<Boolean>	clearParents() Remove all parents in any context combination.
CompletableFuture<Boolean>	clearParents(Set<Context> contexts) Remove all parents in a given context combination.
CompletableFuture<Boolean>	clearPermissions() Clear all permissions set in any context.
CompletableFuture<Boolean>	clearPermissions(Set<Context> context) Clear all permissions set in a given context combination.
Map<Set<Context>,Map<String,String>>	getAllOptions() Return all options for all context combinations currently registered.
Map<Set<Context>,List<SubjectReference>>	getAllParents() Return all registered parent subjects for all contexts.
Map<Set<Context>,Map<String,Boolean>>	getAllPermissions() Return all permissions associated with this data object.
NodeTree	getNodeTree(Set<Context> contexts) Gets the calculated node tree representation of the permissions for this subject data instance.
Map<String,String>	getOptions(Set<Context> contexts) Gets options for a specific context combination.
List<SubjectReference>	getParents(Set<Context> contexts) Return all registered parent subjects for a given context.
Map<String,Boolean>	getPermissions(Set<Context> contexts) Returns the list of permissions set for the given context.
CompletableFuture<Boolean>	removeParent(Set<Context> contexts, SubjectReference parent) Removes a parent in a particular context combination.
CompletableFuture<Boolean>	setOption(Set<Context> contexts, String key, String value) Sets a specific option to a value.
CompletableFuture<Boolean>	setPermission(Set<Context> contexts, String permission, Tristate value) Sets a permission to a given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemorySubjectData

public MemorySubjectData(PermissionService service)

Creates a new subject data instance, using the provided service to request instances of permission subjects.

Parameters:

service - The service to request subjects from

Method Detail

getAllPermissions

public Map<Set<Context>,Map<String,Boolean>> getAllPermissions()

Description copied from interface: SubjectData

Return all permissions associated with this data object.

Specified by:

getAllPermissions in interface SubjectData

Returns:

an immutable copy of the mappings between contexts and lists of permissions containing every permission registered

getNodeTree

public NodeTree getNodeTree(Set<Context> contexts)

Gets the calculated node tree representation of the permissions for this subject data instance. If no data is present for the given context, returns null.

Parameters:

contexts - The contexts to get a node tree for

Returns:

The node tree

getPermissions

public Map<String,Boolean> getPermissions(Set<Context> contexts)

Description copied from interface: SubjectData

Returns the list of permissions set for the given context.

This list is immutable and is not a live view. If no permissions have been set, it returns an empty list.

Specified by:

getPermissions in interface SubjectData

Parameters:

contexts - The particular context combination to check

Returns:

Any permissions set

setPermission

public CompletableFuture<Boolean> setPermission(Set<Context> contexts,
                                                String permission,
                                                Tristate value)

Description copied from interface: SubjectData

Sets a permission to a given value.

Setting value as Tristate.UNDEFINED unsets the permission.

An empty set of contexts applies this permission to the global context.

Specified by:

setPermission in interface SubjectData

Parameters:

contexts - The particular combination of contexts to set this permission in

permission - The permission to set

value - The value to set this permission to

Returns:

Whether the operation was successful

clearPermissions

public CompletableFuture<Boolean> clearPermissions()

Description copied from interface: SubjectData

Clear all permissions set in any context.

Specified by:

clearPermissions in interface SubjectData

Returns:

Whether any change occurred

clearPermissions

public CompletableFuture<Boolean> clearPermissions(Set<Context> context)

Description copied from interface: SubjectData

Clear all permissions set in a given context combination.

Passing an empty context set clears permissions in the global context.

Specified by:

clearPermissions in interface SubjectData

Parameters:

context - The context combination to clear permissions in

Returns:

Whether any change occurred

getAllParents

public Map<Set<Context>,List<SubjectReference>> getAllParents()

Description copied from interface: SubjectData

Return all registered parent subjects for all contexts.

The returned map is immutable and not a live view. The results of this method do not traverse any sort of inheritance structure a permissions plugin may implement.

Specified by:

getAllParents in interface SubjectData

Returns:

All registered parents and the context they are registered in

getParents

public List<SubjectReference> getParents(Set<Context> contexts)

Description copied from interface: SubjectData

Return all registered parent subjects for a given context.

The returned map is immutable and not a live view. The results of this method do not traverse any sort of inheritance structure a permissions plugin may implement.

Specified by:

getParents in interface SubjectData

Parameters:

contexts - The context to check

Returns:

names of parents valid in the given context

addParent

public CompletableFuture<Boolean> addParent(Set<Context> contexts,
                                            SubjectReference parent)

Description copied from interface: SubjectData

Adds a parent in a particular context combination.

Passing an empty context combination means the parent is added in the global context.

Specified by:

addParent in interface SubjectData

Parameters:

contexts - The context combination this operation is applicable to

parent - The name of the parent to add

Returns:

Whether the operation was successful

removeParent

public CompletableFuture<Boolean> removeParent(Set<Context> contexts,
                                               SubjectReference parent)

Description copied from interface: SubjectData

Removes a parent in a particular context combination.

Passing an empty context combination means the parent is removed in the global context.

Specified by:

removeParent in interface SubjectData

Parameters:

contexts - The context combination this operation is applicable to

parent - The name of the parent to remove

Returns:

Whether the operation was successful

clearParents

public CompletableFuture<Boolean> clearParents()

Description copied from interface: SubjectData

Remove all parents in any context combination.

Specified by:

clearParents in interface SubjectData

Returns:

Whether any change occurred

clearParents

public CompletableFuture<Boolean> clearParents(Set<Context> contexts)

Description copied from interface: SubjectData

Remove all parents in a given context combination.

Passing an empty context set clears parents in the global context.

Specified by:

clearParents in interface SubjectData

Parameters:

contexts - The context combination to clear the parents of

Returns:

Whether any change occurred

getAllOptions

public Map<Set<Context>,Map<String,String>> getAllOptions()

Description copied from interface: SubjectData

Return all options for all context combinations currently registered.

Specified by:

getAllOptions in interface SubjectData

Returns:

An immutable snapshot of all options data

getOptions

public Map<String,String> getOptions(Set<Context> contexts)

Description copied from interface: SubjectData

Gets options for a specific context combination.

Specified by:

getOptions in interface SubjectData

Parameters:

contexts - The context combination to get options for

Returns:

All available options, returning an empty map if none are present

setOption

public CompletableFuture<Boolean> setOption(Set<Context> contexts,
                                            String key,
                                            @Nullable
                                            String value)

Description copied from interface: SubjectData

Sets a specific option to a value.

Passing a null value will unset the option.

Specified by:

setOption in interface SubjectData

Parameters:

contexts - The context combination to set the given option in

key - The key to set. Case-insensitive.

value - The value to set.

Returns:

Whether the operation was successful

clearOptions

public CompletableFuture<Boolean> clearOptions(Set<Context> contexts)

Description copied from interface: SubjectData

Clear all options in the given context combination.

Passing an empty context set clears options in the global context.

Specified by:

clearOptions in interface SubjectData

Parameters:

contexts - The context combination

Returns:

Whether the operation was successful (any options were removed)

clearOptions

public CompletableFuture<Boolean> clearOptions()

Description copied from interface: SubjectData

Clear all options.

Specified by:

clearOptions in interface SubjectData

Returns:

Whether the operation was successful