Package ca.stellardrift.permissionsex.minecraft

Class MinecraftPermissionsEx<T>

java.lang.Object

ca.stellardrift.permissionsex.minecraft.MinecraftPermissionsEx<T>

All Implemented Interfaces:

Closeable, AutoCloseable

public final class MinecraftPermissionsEx<T>
extends Object
implements Closeable

An implementation of the Minecraft-specific parts of PermissionsEx

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MinecraftPermissionsEx.Builder<C>	A builder for a Minecraft PermissionsEx engine.

Method Summary

Modifier and Type	Method	Description
Path	baseDirectory(BaseDirectoryScope scope)	Get a game-specific base directory for a certain socpe.
static MinecraftPermissionsEx.Builder<Void>	builder()	Create a new builder for a Minecraft permissions engine.
static <V> MinecraftPermissionsEx.Builder<V>	builder(Class<V> configType)	Create a new builder for a Minecraft permissions engine.
CallbackController	callbackController()	Get the command callback controller for this permissions instance
void	close()
void	describe(net.kyori.adventure.audience.Audience receiver, boolean verbose)	Describe this PermissionsEx implementation.
ca.stellardrift.permissionsex.impl.PermissionsEx<T>	engine()	Get the engine backing this PermissionsEx instance.
ca.stellardrift.permissionsex.subject.SubjectTypeCollection<String>	groups()	Get group subjects.
MessageFormatter	messageFormatter()	Get a message formatter that can be used for styling user output.
T	platformConfig()	Get the platform-specific configuration section.
ca.stellardrift.permissionsex.subject.SubjectTypeCollection<UUID>	users()	Get user subjects.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static MinecraftPermissionsEx.Builder<Void> builder()

Create a new builder for a Minecraft permissions engine.

Returns:

the builder

Since:

2.0.0

builder

public static <V> MinecraftPermissionsEx.Builder<V> builder(Class<V> configType)

Create a new builder for a Minecraft permissions engine.

Type Parameters:

V - platform configuration type

Parameters:

configType - class of platform configuration

Returns:

the builder

Since:

2.0.0

engine

public ca.stellardrift.permissionsex.impl.PermissionsEx<T> engine()

Get the engine backing this PermissionsEx instance.

Returns:

the backing engine

Since:

2.0.0

users

public ca.stellardrift.permissionsex.subject.SubjectTypeCollection<UUID> users()

Get user subjects.

User subject identifiers are UUIDs.

Returns:

the collection of user subjects

Since:

2.0.0

groups

public ca.stellardrift.permissionsex.subject.SubjectTypeCollection<String> groups()

Get group subjects.

Group subject identifiers are any string.

Returns:

the collection of group subjects

Since:

2.0.0

callbackController

public CallbackController callbackController()

Get the command callback controller for this permissions instance

Returns:

The callback controller

describe

public void describe(net.kyori.adventure.audience.Audience receiver,
                     boolean verbose)

Describe this PermissionsEx implementation.

Parameters:

receiver - the receiver for the messages

verbose - whether verbose information should be printed

baseDirectory

public Path baseDirectory(BaseDirectoryScope scope)

Get a game-specific base directory for a certain socpe.

Parameters:

scope - the scope

Returns:

a base directory

Since:

2.0.0

messageFormatter

public MessageFormatter messageFormatter()

Get a message formatter that can be used for styling user output.

Returns:

the formatter

platformConfig

public T platformConfig()

Get the platform-specific configuration section.

Returns:

the platform configuration instance

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable