Node (luckperms-api 4.1 API)

All Known Subinterfaces:

LocalizedNode
```
@Immutable
public interface Node
```
Represents a LuckPerms "node".
The Node class encapsulates more than just permission assignments. Nodes are used to store data about inherited groups, as well as assigned prefixes, suffixes and meta values.

Combining these various states into one object (a "node") means that a holder only has to have one type of data set (a set of nodes) in order to take on various properties.

It is recommended that users of the API make use of Streams to manipulate data and obtain the required information.

This interface provides a number of methods to read the attributes of the node, as well as methods to query and extract additional state and properties from these settings.

Nodes have the following attributes:
- permission - the actual permission string
- value - the value of the node (false for negated)
- override - if the node is marked as having special priority over other nodes
- server - the specific server where this node should apply
- world - the specific world where this node should apply
- context - the additional contexts required for this node to apply
- expiry - the time when this node should expire
Nodes can also fall into the following sub categories.
- normal - just a regular permission
- group node - a "group node" marks that the holder should inherit data from another group
- prefix - represents an assigned prefix
- suffix - represents an assigned suffix
- meta - represents an assigned meta option
The core node state must be immutable in all implementations.
Since:

2.6

See Also:

for obtaining and constructing instances.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Node.Builder
Builds a Node instance

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Node.Builder` Builds a Node instance

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default boolean`	`almostEquals(Node other)` Deprecated. in favour of `equals(Node, NodeEqualityPredicate)`
`boolean`	`appliesGlobally()` Gets if this node applies globally, and therefore has no specific context
`default boolean`	`equals(Node other, NodeEqualityPredicate equalityPredicate)` Returns if this Node is equal to another node as defined by the given `NodeEqualityPredicate`.
`boolean`	`equals(Object obj)` Returns if this Node is equal to another node
`default boolean`	`equalsIgnoringValue(Node other)` Deprecated. in favour of `equals(Node, NodeEqualityPredicate)`
`default boolean`	`equalsIgnoringValueOrTemp(Node other)` Deprecated. in favour of `equals(Node, NodeEqualityPredicate)`
`ContextSet`	`getContexts()` Gets the extra contexts required for this node to apply
`Date`	`getExpiry()` Gets the date when this node will expire
`long`	`getExpiryUnixTime()` Gets a unix timestamp in seconds when this node will expire
`ContextSet`	`getFullContexts()` The same as `getContexts()`, but also includes values for "server" and "world" keys if present.
`String`	`getGroupName()` Gets the name of the group, if this is a group node.
`Map.Entry<String,String>`	`getMeta()` Gets the meta value from this node
`String`	`getPermission()` Gets the permission string
`Map.Entry<Integer,String>`	`getPrefix()` Gets the prefix value from this node
`long`	`getSecondsTilExpiry()` Gets the number of seconds until this permission will expire
`Optional<String>`	`getServer()` Gets the server this node applies on, if the node is server specific
`Map.Entry<Integer,String>`	`getSuffix()` Gets the suffix value from this node
`default Tristate`	`getTristate()` Gets the value of this node as a `Tristate`
`default Boolean`	`getValue()` Gets the value.
`boolean`	`getValuePrimitive()` Gets the value.
`int`	`getWildcardLevel()` Gets the level of this wildcard, higher is more specific
`Optional<String>`	`getWorld()` Gets the world this node applies on, if the node is world specific
`boolean`	`hasExpired()` Gets if the node has expired.
`boolean`	`hasSpecificContext()` Gets if this node has any specific context in order for it to apply
`boolean`	`isGroupNode()` Gets if this is a group node
`boolean`	`isMeta()` Gets if this node is a meta node
`default boolean`	`isNegated()` Gets if the node is negated
`boolean`	`isOverride()` Gets if this node is set to override explicitly.
`default boolean`	`isPermanent()` Gets if this node will not expire
`boolean`	`isPrefix()` Gets if this node is a prefix node
`boolean`	`isServerSpecific()` Gets if this node is server specific
`boolean`	`isSuffix()` Gets if this node is a suffix node
`boolean`	`isTemporary()` Gets if this node will expire in the future
`boolean`	`isWildcard()` Gets if this node is a wildcard node
`boolean`	`isWorldSpecific()` Gets if this node is server specific
`List<String>`	`resolveShorthand()` Resolves any shorthand parts of this node and returns the full list
`boolean`	`shouldApplyWithContext(ContextSet context)` Gets if this node should apply in the given context
`boolean`	`standardEquals(Node other, StandardNodeEquality equalityPredicate)` Returns if this Node is equal to another node as defined by the given `StandardNodeEquality` predicate.
`Node.Builder`	`toBuilder()` Constructs a new builder initially containing the current properties of this node.

- Method Detail
  - getPermission
```
@Nonnull
String getPermission()
```
    Gets the permission string
    
    Returns:
    
    the actual permission node
  - getValue
```
@Nonnull
default Boolean getValue()
```
    Gets the value.
    A negated node would return a value of false.
    
    Returns:
    
    the permission's value
  - getValuePrimitive
```
boolean getValuePrimitive()
```
    Gets the value.
    A negated node would return a value of false.
    
    Returns:
    
    the permission's value
  - getTristate
```
@Nonnull
default Tristate getTristate()
```
    Gets the value of this node as a Tristate
    
    Returns:
    
    the value of this node as a Tristate
  - isNegated
```
default boolean isNegated()
```
    Gets if the node is negated
    
    Returns:
    
    true if the node is negated
  - isOverride
```
boolean isOverride()
```
    Gets if this node is set to override explicitly.
    This value does not persist across saves, and is therefore only useful for transient nodes
    
    Returns:
    
    true if this node is set to override explicitly
  - getServer
```
@Nonnull
Optional<String> getServer()
```
    Gets the server this node applies on, if the node is server specific
    
    Returns:
    
    an Optional containing the server, if one is defined
  - getWorld
```
@Nonnull
Optional<String> getWorld()
```
    Gets the world this node applies on, if the node is world specific
    
    Returns:
    
    an Optional containing the world, if one is defined
  - isServerSpecific
```
boolean isServerSpecific()
```
    Gets if this node is server specific
    
    Returns:
    
    true if this node is server specific
  - isWorldSpecific
```
boolean isWorldSpecific()
```
    Gets if this node is server specific
    
    Returns:
    
    true if this node is server specific
  - appliesGlobally
```
boolean appliesGlobally()
```
    Gets if this node applies globally, and therefore has no specific context
    
    Returns:
    
    true if this node applies globally, and has no specific context
    
    Since:
    
    3.1
  - hasSpecificContext
```
boolean hasSpecificContext()
```
    Gets if this node has any specific context in order for it to apply
    
    Returns:
    
    true if this node has specific context
    
    Since:
    
    3.1
  - shouldApplyWithContext
```
boolean shouldApplyWithContext(@Nonnull
                               ContextSet context)
```
    Gets if this node should apply in the given context
    
    Parameters:
    
    context - the context key value pairs
    
    Returns:
    
    true if the node should apply
    
    Since:
    
    2.13
  - resolveShorthand
```
@Nonnull
List<String> resolveShorthand()
```
    Resolves any shorthand parts of this node and returns the full list
    
    Returns:
    
    a list of full nodes
  - isTemporary
```
boolean isTemporary()
```
    Gets if this node will expire in the future
    
    Returns:
    
    true if this node will expire in the future
  - isPermanent
```
default boolean isPermanent()
```
    Gets if this node will not expire
    
    Returns:
    
    true if this node will not expire
  - getExpiryUnixTime
```
long getExpiryUnixTime()
                throws IllegalStateException
```
    Gets a unix timestamp in seconds when this node will expire
    
    Returns:
    
    the time in Unix time when this node will expire
    
    Throws:
    
    IllegalStateException - if the node is not temporary
  - getExpiry
```
@Nonnull
Date getExpiry()
                  throws IllegalStateException
```
    Gets the date when this node will expire
    
    Returns:
    
    the Date when this node will expire
    
    Throws:
    
    IllegalStateException - if the node is not temporary
  - getSecondsTilExpiry
```
long getSecondsTilExpiry()
                  throws IllegalStateException
```
    Gets the number of seconds until this permission will expire
    
    Returns:
    
    the number of seconds until this permission will expire
    
    Throws:
    
    IllegalStateException - if the node is not temporary
  - hasExpired
```
boolean hasExpired()
```
    Gets if the node has expired.
    This also returns false if the node is not temporary.
    
    Returns:
    
    true if this node has expired
  - getContexts
```
@Nonnull
ContextSet getContexts()
```
    Gets the extra contexts required for this node to apply
    
    Returns:
    
    the extra contexts required for this node to apply
    
    Since:
    
    2.13
  - getFullContexts
```
@Nonnull
ContextSet getFullContexts()
```
    The same as getContexts(), but also includes values for "server" and "world" keys if present.
    
    Returns:
    
    the full contexts required for this node to apply
    
    Since:
    
    3.1
  - isGroupNode
```
boolean isGroupNode()
```
    Gets if this is a group node
    
    Returns:
    
    true if this is a group node
  - getGroupName
```
@Nonnull
String getGroupName()
                       throws IllegalStateException
```
    Gets the name of the group, if this is a group node.
    
    Returns:
    
    the name of the group
    
    Throws:
    
    IllegalStateException - if this is not a group node. See isGroupNode()
  - isWildcard
```
boolean isWildcard()
```
    Gets if this node is a wildcard node
    
    Returns:
    
    true if this node is a wildcard node
  - getWildcardLevel
```
int getWildcardLevel()
              throws IllegalStateException
```
    Gets the level of this wildcard, higher is more specific
    
    Returns:
    
    the wildcard level
    
    Throws:
    
    IllegalStateException - if this is not a wildcard
  - isMeta
```
boolean isMeta()
```
    Gets if this node is a meta node
    
    Returns:
    
    true if this node is a meta node
  - getMeta
```
@Nonnull
Map.Entry<String,String> getMeta()
                                    throws IllegalStateException
```
    Gets the meta value from this node
    
    Returns:
    
    the meta value
    
    Throws:
    
    IllegalStateException - if this node is not a meta node
  - isPrefix
```
boolean isPrefix()
```
    Gets if this node is a prefix node
    
    Returns:
    
    true if this node is a prefix node
  - getPrefix
```
@Nonnull
Map.Entry<Integer,String> getPrefix()
                                       throws IllegalStateException
```
    Gets the prefix value from this node
    
    Returns:
    
    the prefix value
    
    Throws:
    
    IllegalStateException - if this node is a not a prefix node
  - isSuffix
```
boolean isSuffix()
```
    Gets if this node is a suffix node
    
    Returns:
    
    true if this node is a suffix node
  - getSuffix
```
@Nonnull
Map.Entry<Integer,String> getSuffix()
                                       throws IllegalStateException
```
    Gets the suffix value from this node
    
    Returns:
    
    the suffix value
    
    Throws:
    
    IllegalStateException - if this node is a not a suffix node
  - equals
```
boolean equals(Object obj)
```
    Returns if this Node is equal to another node
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the other node
    
    Returns:
    
    true if this node is equal to the other provided
    
    See Also:
    
    StandardNodeEquality.EXACT
  - standardEquals
```
boolean standardEquals(Node other,
                       StandardNodeEquality equalityPredicate)
```
    Returns if this Node is equal to another node as defined by the given StandardNodeEquality predicate.
    
    Parameters:
    
    other - the other node
    
    equalityPredicate - the predicate
    
    Returns:
    
    true if this node is considered equal
    
    Since:
    
    4.1
  - equals
```
default boolean equals(Node other,
                       NodeEqualityPredicate equalityPredicate)
```
    Returns if this Node is equal to another node as defined by the given NodeEqualityPredicate.
    
    Parameters:
    
    other - the other node
    
    equalityPredicate - the predicate
    
    Returns:
    
    true if this node is considered equal
    
    Since:
    
    4.1
  - equalsIgnoringValue
```
@Deprecated
default boolean equalsIgnoringValue(@Nonnull
                                                 Node other)
```
    Deprecated. in favour of equals(Node, NodeEqualityPredicate)
    
    Similar to equals(Object), except doesn't take note of the value.
    
    Parameters:
    
    other - the other node
    
    Returns:
    
    true if the two nodes are almost equal
    
    See Also:
    
    StandardNodeEquality.IGNORE_VALUE
  - almostEquals
```
@Deprecated
default boolean almostEquals(@Nonnull
                                          Node other)
```
    Deprecated. in favour of equals(Node, NodeEqualityPredicate)
    
    Similar to equals(Object), except doesn't take note of the expiry time or value.
    
    Parameters:
    
    other - the other node
    
    Returns:
    
    true if the two nodes are almost equal
    
    See Also:
    
    StandardNodeEquality.IGNORE_EXPIRY_TIME_AND_VALUE
  - equalsIgnoringValueOrTemp
```
@Deprecated
default boolean equalsIgnoringValueOrTemp(@Nonnull
                                                       Node other)
```
    Deprecated. in favour of equals(Node, NodeEqualityPredicate)
    
    Similar to equals(Object), except doesn't take note of the value or if the node is temporary.
    
    Parameters:
    
    other - the other node
    
    Returns:
    
    true if the two nodes are almost equal
    
    Since:
    
    2.8
    
    See Also:
    
    StandardNodeEquality.IGNORE_VALUE_OR_IF_TEMPORARY
  - toBuilder
```
Node.Builder toBuilder()
```
    Constructs a new builder initially containing the current properties of this node.
    
    Returns:
    
    a new builder
    
    Since:
    
    4.1

Interface Node

Nested Class Summary

Method Summary

Method Detail

getPermission

getValue

getValuePrimitive

getTristate

isNegated

isOverride

getServer

getWorld

isServerSpecific

isWorldSpecific

appliesGlobally

hasSpecificContext

shouldApplyWithContext

resolveShorthand

isTemporary

isPermanent

getExpiryUnixTime

getExpiry

getSecondsTilExpiry

hasExpired

getContexts

getFullContexts

isGroupNode

getGroupName

isWildcard

getWildcardLevel

isMeta

getMeta

isPrefix

getPrefix

isSuffix

getSuffix

equals

standardEquals

equals

equalsIgnoringValue

almostEquals

equalsIgnoringValueOrTemp

toBuilder