me.lucko.luckperms.api

Interface Node.Builder

Enclosing interface:

Node

public static interface Node.Builder

Builds a Node instance

Method Summary

Modifier and Type	Method and Description
@NonNull Node	build() Creates a Node instance from the builder.
@NonNull Node.Builder	clearExpiry() Marks that the node being built should never expire.
Node.Builder	copyFrom(@NonNull Node node) Copies the attributes from the given node and applies them to this builder.
@NonNull Node.Builder	setExpiry(long expiryUnixTimestamp) Sets the time when the node should expire.
default @NonNull Node.Builder	setExpiry(long duration, TimeUnit unit) Sets the time when the node should expire.
@NonNull Node.Builder	setExtraContext(@NonNull ContextSet contextSet) Sets the extra contexts for the node.
@NonNull Node.Builder	setNegated(boolean negated) Sets the value of negated for the node.
@NonNull Node.Builder	setOverride(boolean override) Sets the override property for the node.
@NonNull Node.Builder	setServer(@Nullable String server) Sets the server value for the node.
@NonNull Node.Builder	setValue(boolean value) Sets the value of the node.
@NonNull Node.Builder	setWorld(@Nullable String world) Sets the world value for the node.
@NonNull Node.Builder	withExtraContext(@NonNull ContextSet contextSet) Appends extra contexts onto the node.
@NonNull Node.Builder	withExtraContext(Map.Entry<String,String> entry) Appends an extra context onto the node.
@NonNull Node.Builder	withExtraContext(@NonNull Map<String,String> map) Appends extra contexts onto the node.
@NonNull Node.Builder	withExtraContext(@NonNull Set<Map.Entry<String,String>> context) Appends extra contexts onto the node.
@NonNull Node.Builder	withExtraContext(@NonNull String key, @NonNull String value) Appends an extra context onto the node.

Method Detail

copyFrom

Node.Builder copyFrom(@NonNull Node node)

Copies the attributes from the given node and applies them to this builder.

Note that this copies all attributes except the permission itself.

Parameters:

node - the node to copy from

Returns:

the builder

Since:

4.2

setNegated

@NonNull Node.Builder setNegated(boolean negated)

Sets the value of negated for the node.

Parameters:

negated - the value

Returns:

the builder

See Also:

Node.isNegated()

setValue

@NonNull Node.Builder setValue(boolean value)

Sets the value of the node.

Parameters:

value - the value

Returns:

the builder

See Also:

Node.getValue()

setOverride

@NonNull Node.Builder setOverride(boolean override)

Sets the override property for the node.

Warning: this value does not persist, and disappears when the holder is re-loaded. It is therefore only useful for transient nodes.

Parameters:

override - the override state

Returns:

the builder

See Also:

Node.isOverride()

setExpiry

@NonNull Node.Builder setExpiry(long expiryUnixTimestamp)

Sets the time when the node should expire.

The parameter passed to this method must be the unix timestamp (in seconds) when the node should expire.

Parameters:

expiryUnixTimestamp - the expiry timestamp (unix seconds)

Returns:

the builder

See Also:

Node.getExpiryUnixTime()

setExpiry

default @NonNull Node.Builder setExpiry(long duration,
                                        TimeUnit unit)

Sets the time when the node should expire.

The expiry timestamp is calculated relative to the current system time.

Parameters:

duration - how long the node should be added for

unit - the unit duration is measured in

Returns:

the builder

Since:

4.2

clearExpiry

@NonNull Node.Builder clearExpiry()

Marks that the node being built should never expire.

Returns:

the builder

Since:

4.2

setWorld

@NonNull Node.Builder setWorld(@Nullable String world)

Sets the world value for the node.

Parameters:

world - the world value

Returns:

the builder

See Also:

Node.getWorld()

setServer

@NonNull Node.Builder setServer(@Nullable String server)

Sets the server value for the node.

Parameters:

server - the world value

Returns:

the builder

See Also:

Node.getServer()

withExtraContext

@NonNull Node.Builder withExtraContext(@NonNull String key,
                                       @NonNull String value)

Appends an extra context onto the node.

Parameters:

key - the context key

value - the context value

Returns:

the builder

See Also:

ContextSet, Node.getContexts()

withExtraContext

@NonNull Node.Builder withExtraContext(@NonNull Map<String,String> map)

Appends extra contexts onto the node.

Parameters:

map - a map of contexts

Returns:

the builder

See Also:

ContextSet, Node.getContexts()

withExtraContext

@NonNull Node.Builder withExtraContext(@NonNull Set<Map.Entry<String,String>> context)

Appends extra contexts onto the node.

Parameters:

context - a set of contexts

Returns:

the builder

See Also:

ContextSet, Node.getContexts()

withExtraContext

@NonNull Node.Builder withExtraContext(Map.Entry<String,String> entry)

Appends an extra context onto the node.

Parameters:

entry - the context

Returns:

the builder

See Also:

ContextSet, Node.getContexts()

withExtraContext

@NonNull Node.Builder withExtraContext(@NonNull ContextSet contextSet)

Appends extra contexts onto the node.

Parameters:

contextSet - a context set

Returns:

the builder

See Also:

ContextSet, Node.getContexts()

setExtraContext

@NonNull Node.Builder setExtraContext(@NonNull ContextSet contextSet)

Sets the extra contexts for the node.

Parameters:

contextSet - a context set

Returns:

the builder

Since:

4.2

See Also:

ContextSet, Node.getContexts()

build

@NonNull Node build()

Creates a Node instance from the builder.

Returns:

a new node instance