Node (luckperms-api 4.3 API)

All Known Subinterfaces:

LocalizedNode
```
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
The 'permission' property of a Node is also used in some cases to represent state beyond a granted permission. This state is encapsulated by extra NodeType data which can be obtained from this instance using getTypeData(NodeTypeKey).

Type data is mapped by NodeTypeKeys, which are usually stored as static members of the corresponding NodeType class under the KEY field.

The current types are:
- normal - just a regular permission
- InheritanceType - an "inheritance node" marks that the holder should inherit data from another group
- PrefixType - represents an assigned prefix
- SuffixType - represents an assigned suffix
- MetaType - represents an assigned meta option
- WeightType - marks the weight of the object holding this node
- DisplayNameType - marks the display name of the object holding this node
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(@NonNull 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)` Gets if this Node is equal to another node as defined by the given `NodeEqualityPredicate`.
`boolean`	`equals(Object obj)` Gets if this Node is equal to another node.
`default boolean`	`equalsIgnoringValue(@NonNull Node other)` Deprecated. in favour of `equals(Node, NodeEqualityPredicate)`
`default boolean`	`equalsIgnoringValueOrTemp(@NonNull Node other)` Deprecated. in favour of `equals(Node, NodeEqualityPredicate)`
`@NonNull ContextSet`	`getContexts()` Gets the extra contexts required for this node to apply.
`@NonNull Date`	`getExpiry()` Gets the date when this node will expire.
`long`	`getExpiryUnixTime()` Gets the unix timestamp (in seconds) when this node will expire.
`@NonNull ContextSet`	`getFullContexts()` The same as `getContexts()`, but also includes context pairs for "server" and "world" keys if present.
`default @NonNull String`	`getGroupName()` Gets the name of the inherited group if this node has `InheritanceType` type data, throwing an exception if the data is not present.
`default Map.Entry<String,String>`	`getMeta()` Gets the meta entry if this node has `MetaType` type data, throwing an exception if the data is not present.
`@NonNull String`	`getPermission()` Gets the permission string this node encapsulates.
`default Map.Entry<Integer,String>`	`getPrefix()` Gets the prefix entry if this node has `PrefixType` type data, throwing an exception if the data is not present.
`long`	`getSecondsTilExpiry()` Gets the number of seconds until this permission will expire.
`@NonNull Optional<String>`	`getServer()` Gets the server this node applies on, if the node is server specific.
`default Map.Entry<Integer,String>`	`getSuffix()` Gets the suffix entry if this node has `SuffixType` type data, throwing an exception if the data is not present.
`default @NonNull Tristate`	`getTristate()` Gets the value of this node as a `Tristate`.
`<T extends NodeType> Optional<T>`	`getTypeData(NodeTypeKey<T> key)` Gets the type data corresponding to the given `key`, if present.
`boolean`	`getValue()` Gets the value of the node.
`int`	`getWildcardLevel()` Gets the level of this wildcard.
`@NonNull 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`	`hasTypeData()` Gets if this node has any extra `NodeType` data attached to it.
`default boolean`	`isGroupNode()` Gets if this node has `InheritanceType` type data.
`default boolean`	`isMeta()` Gets if this node has `MetaType` type data.
`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 is permanent (will not expire).
`default boolean`	`isPrefix()` Gets if this node has `PrefixType` type data.
`boolean`	`isServerSpecific()` Gets if this node is server specific.
`default boolean`	`isSuffix()` Gets if this node has `SuffixType` type data.
`boolean`	`isTemporary()` Gets if this node is assigned temporarily.
`boolean`	`isWildcard()` Gets if this node is a wildcard permission.
`boolean`	`isWorldSpecific()` Gets if this node is server specific.
`@NonNull List<String>`	`resolveShorthand()` Resolves any shorthand parts of this node and returns the full list of resolved nodes.
`boolean`	`shouldApplyWithContext(@NonNull ContextSet contextSet)` Gets if this node should apply in the given context
`boolean`	`standardEquals(Node other, StandardNodeEquality equalityPredicate)` Gets 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.
`default <T extends NodeType> T`	`typeData(NodeTypeKey<T> key)` Gets the type data corresponding to the given `key`, throwing an exception if no data is present.

- Method Detail
  - getPermission
```
@NonNull String getPermission()
```
    Gets the permission string this node encapsulates.
    The exact value of this string may vary for nodes which aren't regular permission settings.
    
    Returns:
    
    the actual permission node
  - getValue
```
boolean getValue()
```
    Gets the value of the node.
    A negated setting would result in a value of false.
    
    Returns:
    
    the nodes value
  - getTristate
```
default @NonNull 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.
    This is the inverse of the value.
    
    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 contextSet)
```
    Gets if this node should apply in the given context
    
    Parameters:
    
    contextSet - the context set
    
    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 of resolved nodes.
    The list will not contain the exact permission itself.
    
    Returns:
    
    a list of full nodes
  - isTemporary
```
boolean isTemporary()
```
    Gets if this node is assigned temporarily.
    
    Returns:
    
    true if this node will expire in the future
  - isPermanent
```
default boolean isPermanent()
```
    Gets if this node is permanent (will not expire).
    
    Returns:
    
    true if this node will not expire
  - getExpiryUnixTime
```
long getExpiryUnixTime()
                throws IllegalStateException
```
    Gets the 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.
    Will return a negative value if the node has already expired.
    
    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 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 context pairs for "server" and "world" keys if present.
    
    Returns:
    
    the full contexts required for this node to apply
    
    Since:
    
    3.1
    
    See Also:
    
    Contexts.SERVER_KEY, Contexts.WORLD_KEY
  - isWildcard
```
boolean isWildcard()
```
    Gets if this node is a wildcard permission.
    
    Returns:
    
    true if this node is a wildcard permission
  - getWildcardLevel
```
int getWildcardLevel()
              throws IllegalStateException
```
    Gets the level of this wildcard.
    The node luckperms.* has a wildcard level of 1.
    
    The node luckperms.user.permission.* has a wildcard level of 3.
    
    Nodes with a higher wildcard level are more specific and have priority over less specific nodes (nodes with a lower wildcard level).
    
    Returns:
    
    the wildcard level
    
    Throws:
    
    IllegalStateException - if this is not a wildcard
  - hasTypeData
```
boolean hasTypeData()
```
    Gets if this node has any extra NodeType data attached to it.
    
    Returns:
    
    if this node has any type data
    
    Since:
    
    4.2
  - getTypeData
```
<T extends NodeType> Optional<T> getTypeData(NodeTypeKey<T> key)
```
    Gets the type data corresponding to the given key, if present.
    
    Type Parameters:
    
    T - the NodeType type
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the data, if present
    
    Since:
    
    4.2
  - typeData
```
default <T extends NodeType> T typeData(NodeTypeKey<T> key)
                                 throws IllegalStateException
```
    Gets the type data corresponding to the given key, throwing an exception if no data is present.
    
    Type Parameters:
    
    T - the NodeType type
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the data
    
    Throws:
    
    IllegalStateException - if data isn't present
    
    Since:
    
    4.2
  - isGroupNode
```
default boolean isGroupNode()
```
    Gets if this node has InheritanceType type data.
    
    Returns:
    
    true if this is a inheritance (group) node.
  - getGroupName
```
default @NonNull String getGroupName()
                              throws IllegalStateException
```
    Gets the name of the inherited group if this node has InheritanceType type data, throwing an exception if the data is not present.
    
    Returns:
    
    the name of the group
    
    Throws:
    
    IllegalStateException - if this node doesn't have InheritanceType data
  - isMeta
```
default boolean isMeta()
```
    Gets if this node has MetaType type data.
    
    Returns:
    
    true if this is a meta node.
  - getMeta
```
default Map.Entry<String,String> getMeta()
                                  throws IllegalStateException
```
    Gets the meta entry if this node has MetaType type data, throwing an exception if the data is not present.
    
    Returns:
    
    the meta entry
    
    Throws:
    
    IllegalStateException - if this node doesn't have MetaType data
  - isPrefix
```
default boolean isPrefix()
```
    Gets if this node has PrefixType type data.
    
    Returns:
    
    true if this node is a prefix node
  - getPrefix
```
default Map.Entry<Integer,String> getPrefix()
                                     throws IllegalStateException
```
    Gets the prefix entry if this node has PrefixType type data, throwing an exception if the data is not present.
    
    Returns:
    
    the meta entry
    
    Throws:
    
    IllegalStateException - if this node doesn't have PrefixType data
  - isSuffix
```
default boolean isSuffix()
```
    Gets if this node has SuffixType type data.
    
    Returns:
    
    true if this node is a suffix node
  - getSuffix
```
default Map.Entry<Integer,String> getSuffix()
                                     throws IllegalStateException
```
    Gets the suffix entry if this node has SuffixType type data, throwing an exception if the data is not present.
    
    Returns:
    
    the meta entry
    
    Throws:
    
    IllegalStateException - if this node doesn't have SuffixType data
  - equals
```
boolean equals(Object obj)
```
    Gets 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)
```
    Gets 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)
```
    Gets 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

getTristate

isNegated

isOverride

getServer

getWorld

isServerSpecific

isWorldSpecific

appliesGlobally

hasSpecificContext

shouldApplyWithContext

resolveShorthand

isTemporary

isPermanent

getExpiryUnixTime

getExpiry

getSecondsTilExpiry

hasExpired

getContexts

getFullContexts

isWildcard

getWildcardLevel

hasTypeData

getTypeData

typeData

isGroupNode

getGroupName

isMeta

getMeta

isPrefix

getPrefix

isSuffix

getSuffix

equals

standardEquals

equals

equalsIgnoringValue

almostEquals

equalsIgnoringValueOrTemp

toBuilder