1
0
mirror of https://github.com/lucko/LuckPerms.git synced 2025-09-02 10:52:37 +02:00

Release 1.6

This commit is contained in:
Luck
2016-08-28 22:05:10 +01:00
parent 6aea3b53f3
commit 57f5a7c4cd
11 changed files with 57 additions and 26 deletions

View File

@@ -133,7 +133,7 @@ public interface Datastore {
boolean cleanupUsers();
/**
* Gets a set user's UUIDs who are "unique", aren't just a member of the "default" group.
* Gets a set all user's UUIDs who are "unique", and aren't just a member of the "default" group.
* @return a set of uuids, or null if the operation failed.
* @since 1.6
*/

View File

@@ -53,12 +53,14 @@ public interface LuckPermsApi {
/**
* Registers a listener to be sent LuckPerms events
* @param listener the listener instance
* @throws NullPointerException if the listener is null
*/
void registerListener(LPListener listener);
/**
* Unregisters a previously registered listener from the EventBus
* @param listener the listener instance to unregister
* @throws NullPointerException if the listener is null
*/
void unregisterListener(LPListener listener);
@@ -90,6 +92,7 @@ public interface LuckPermsApi {
* Gets a wrapped user object from the user storage
* @param uuid the uuid of the user to get
* @return a {@link User} object, if one matching the uuid is loaded, or null if not
* @throws NullPointerException if the uuid is null
*/
User getUser(UUID uuid);
@@ -97,6 +100,7 @@ public interface LuckPermsApi {
* Gets a wrapped user object from the user storage. This method does not return null, unlike {@link #getUser(UUID)}
* @param uuid the uuid of the user to get
* @return an optional {@link User} object
* @throws NullPointerException if the uuid is null
*/
Optional<User> getUserSafe(UUID uuid);
@@ -104,6 +108,7 @@ public interface LuckPermsApi {
* Gets a wrapped user object from the user storage
* @param name the username of the user to get
* @return a {@link User} object, if one matching the uuid is loaded, or null if not
* @throws NullPointerException if the name is null
*/
User getUser(String name);
@@ -111,6 +116,7 @@ public interface LuckPermsApi {
* Gets a wrapped user object from the user storage. This method does not return null, unlike {@link #getUser(String)}
* @param name the username of the user to get
* @return an optional {@link User} object
* @throws NullPointerException if the name is null
*/
Optional<User> getUserSafe(String name);
@@ -124,13 +130,23 @@ public interface LuckPermsApi {
* Check if a user is loaded in memory
* @param uuid the uuid to check for
* @return true if the user is loaded
* @throws NullPointerException if the uuid is null
*/
boolean isUserLoaded(UUID uuid);
/**
* Unload a user from the internal storage, if they're not currently online.
* @param user the user to unload
* @throws NullPointerException if the user is null
* @since 1.6
*/
void cleanupUser(User user);
/**
* Gets a wrapped group object from the group storage
* @param name the name of the group to get
* @return a {@link Group} object, if one matching the name exists, or null if not
* @throws NullPointerException if the name is null
*/
Group getGroup(String name);
@@ -138,6 +154,7 @@ public interface LuckPermsApi {
* Gets a wrapped group object from the group storage. This method does not return null, unlike {@link #getGroup}
* @param name the name of the group to get
* @return an optional {@link Group} object
* @throws NullPointerException if the name is null
*/
Optional<Group> getGroupSafe(String name);
@@ -151,6 +168,7 @@ public interface LuckPermsApi {
* Check if a group is loaded in memory
* @param name the name to check for
* @return true if the group is loaded
* @throws NullPointerException if the name is null
*/
boolean isGroupLoaded(String name);
@@ -158,6 +176,7 @@ public interface LuckPermsApi {
* Gets a wrapped track object from the track storage
* @param name the name of the track to get
* @return a {@link Track} object, if one matching the name exists, or null if not
* @throws NullPointerException if the name is null
*/
Track getTrack(String name);
@@ -165,6 +184,7 @@ public interface LuckPermsApi {
* Gets a wrapped tracj object from the track storage. This method does not return null, unlike {@link #getTrack}
* @param name the name of the track to get
* @return an optional {@link Track} object
* @throws NullPointerException if the name is null
*/
Optional<Track> getTrackSafe(String name);
@@ -178,6 +198,7 @@ public interface LuckPermsApi {
* Check if a track is loaded in memory
* @param name the name to check for
* @return true if the track is loaded
* @throws NullPointerException if the name is null
*/
boolean isTrackLoaded(String name);
@@ -186,6 +207,7 @@ public interface LuckPermsApi {
* @param permission the main permission node to build
* @return a {@link Node.Builder} instance
* @throws IllegalArgumentException if the permission is invalid
* @throws NullPointerException if the permission is null
* @since 1.6
*/
Node.Builder buildNode(String permission) throws IllegalArgumentException;