me.lucko.luckperms

Class LuckPerms

java.lang.Object

me.lucko.luckperms.LuckPerms

public final class LuckPerms
extends Object

Provides static access to the LuckPermsApi.

Ideally, the ServiceManager for the platform should be used to obtain an instance, however, this provider can be used if you need static access.

Method Summary

Modifier and Type	Method and Description
static @NonNull LuckPermsApi	getApi() Gets an instance of the LuckPermsApi, throwing IllegalStateException if an instance is not yet loaded.
static @NonNull Optional<LuckPermsApi>	getApiSafe() Gets an instance of LuckPermsApi, if it is loaded.

Methods inherited from class java.lang.Object

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

Method Detail

getApi

public static @NonNull LuckPermsApi getApi()

Gets an instance of the LuckPermsApi, throwing IllegalStateException if an instance is not yet loaded.

Will never return null.

Returns:

an api instance

Throws:

IllegalStateException - if the api is not loaded

getApiSafe

public static @NonNull Optional<LuckPermsApi> getApiSafe()

Gets an instance of LuckPermsApi, if it is loaded.

Unlike getApi(), this method will not throw an IllegalStateException if an instance is not yet loaded, rather return an empty Optional.

Returns:

an optional api instance