org.spongepowered.api.service.permission

Class NodeTree

java.lang.Object

org.spongepowered.api.service.permission.NodeTree

public class NodeTree
extends Object

An immutable tree structure for determining node data. Any changes will create new copies of the necessary tree objects.

This class is simply provided as a utility for plugins implementing PermissionService. It is not a requirement that this class is used, however the behaviour defined in Subject regarding implicit node inheritance should be maintained.

• Keys are case-insensitive.
• Segments of nodes are split by the '.' character

Method Summary

Modifier and Type	Method and Description
Map<String,Boolean>	asMap() Convert this node tree into a map of the defined nodes in this tree.
Tristate	get(String node) Returns the value assigned to a specific node, or the nearest parent value in the tree if the node itself is undefined.
static NodeTree	of(Map<String,Boolean> values) Create a new node tree with the given values, and a default value of Tristate.UNDEFINED.
static NodeTree	of(Map<String,Boolean> values, Tristate defaultValue) Create a new node tree with the given values, and the specified root fallback value.
NodeTree	withAll(Map<String,Tristate> values) Return a modified new node tree with the specified values set.
NodeTree	withValue(String node, Tristate value) Return a new NodeTree instance with a single changed value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static NodeTree of(Map<String,Boolean> values)

Create a new node tree with the given values, and a default value of Tristate.UNDEFINED.

Parameters:

values - The values to set

Returns:

The new node tree

of

public static NodeTree of(Map<String,Boolean> values,
                          Tristate defaultValue)

Create a new node tree with the given values, and the specified root fallback value.

Parameters:

values - The values to be contained in this node tree

defaultValue - The fallback value for any completely undefined nodes

Returns:

The newly created node tree

get

public Tristate get(String node)

Returns the value assigned to a specific node, or the nearest parent value in the tree if the node itself is undefined.

Parameters:

node - The path to get the node value at

Returns:

The tristate value for the given node

asMap

public Map<String,Boolean> asMap()

Convert this node tree into a map of the defined nodes in this tree.

Returns:

An immutable map representation of the nodes defined in this tree

withValue

public NodeTree withValue(String node,
                          Tristate value)

Return a new NodeTree instance with a single changed value.

Parameters:

node - The node path to change the value of

value - The value to change, or UNDEFINED to remove

Returns:

The new, modified node tree

withAll

public NodeTree withAll(Map<String,Tristate> values)

Return a modified new node tree with the specified values set.

Parameters:

values - The values to set

Returns:

The new node tree