revxrsal.commands.command

Interface CommandPermission<A extends CommandActor>

All Superinterfaces:

java.util.function.Predicate<A>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CommandPermission<A extends CommandActor>
extends java.util.function.Predicate<A>

Represents a permission that is required in order to execute a command.

This implementation may vary depending on the target platform

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommandPermission.Factory<A extends CommandActor> Represents a convenient way to register custom CommandPermission implementations.

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> CommandPermission<A>	alwaysTrue() Returns a CommandPermission that always returns true for all actors.
boolean	isExecutableBy(A actor) Returns whether the sender has permission to use this command or not.
default boolean	test(A a) Returns whether the sender has permission to use this command or not.

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Method Detail

alwaysTrue

static <A extends CommandActor> CommandPermission<A> alwaysTrue()

Returns a CommandPermission that always returns true for all actors.

Type Parameters:

A - The actor type

Returns:

The permission

isExecutableBy

boolean isExecutableBy(@NotNull
                       A actor)

Returns whether the sender has permission to use this command or not.

Parameters:

actor - Actor to test against

Returns:

true if they can use it, false if otherwise.

test

default boolean test(A a)

Returns whether the sender has permission to use this command or not.

Specified by:

test in interface java.util.function.Predicate<A extends CommandActor>

Parameters:

a - Actor to test against

Returns:

true if they can use it, false if otherwise.