me.lucko.luckperms.api

Interface Track

public interface Track

An ordered chain of Groups.

Method Summary

Modifier and Type	Method and Description
DataMutateResult	appendGroup(Group group) Appends a group to the end of this track
void	clearGroups() Clear all of the groups from this track
boolean	containsGroup(Group group) Checks if a group features on this track
boolean	containsGroup(String group) Checks if a group features on this track
DemotionResult	demote(User user, ContextSet contextSet) Demotes the given user along this track.
List<String>	getGroups() Gets a list of the groups on this track
String	getName() Gets the name of this track
String	getNext(Group current) Gets the next group on the track, after the one provided
String	getPrevious(Group current) Gets the previous group on the track, before the one provided
int	getSize() Gets the number of groups on this track
DataMutateResult	insertGroup(Group group, int position) Inserts a group at a certain position on this track
PromotionResult	promote(User user, ContextSet contextSet) Promotes the given user along this track.
DataMutateResult	removeGroup(Group group) Removes a group from this track
DataMutateResult	removeGroup(String group) Removes a group from this track

Method Detail

getName

@Nonnull
String getName()

Gets the name of this track

Returns:

the name of this track

getGroups

@Nonnull
List<String> getGroups()

Gets a list of the groups on this track

Index 0 is the first/lowest group in (or start of) the track.

The returned collection is immutable, and cannot be modified.

Returns:

an ordered List of the groups on this track

getSize

int getSize()

Gets the number of groups on this track

Returns:

the number of groups on this track

getNext

@Nullable
String getNext(@Nonnull
                          Group current)

Gets the next group on the track, after the one provided

null is returned if the group is not on the track.

Parameters:

current - the group before the group being requested

Returns:

the group name, or null if the end of the track has been reached

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

getPrevious

@Nullable
String getPrevious(@Nonnull
                              Group current)

Gets the previous group on the track, before the one provided

null is returned if the group is not on the track.

Parameters:

current - the group after the group being requested

Returns:

the group name, or null if the start of the track has been reached

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

promote

@Nonnull
PromotionResult promote(@Nonnull
                                  User user,
                                  @Nonnull
                                  ContextSet contextSet)

Promotes the given user along this track.

Parameters:

user - the user to promote

contextSet - the contexts to promote the user in

Returns:

the result of the action

Since:

4.2

demote

@Nonnull
DemotionResult demote(@Nonnull
                                User user,
                                @Nonnull
                                ContextSet contextSet)

Demotes the given user along this track.

Parameters:

user - the user to demote

contextSet - the contexts to demote the user in

Returns:

the result of the action

Since:

4.2

appendGroup

@Nonnull
DataMutateResult appendGroup(@Nonnull
                                       Group group)

Appends a group to the end of this track

Parameters:

group - the group to append

Returns:

the result of the operation

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

insertGroup

@Nonnull
DataMutateResult insertGroup(@Nonnull
                                       Group group,
                                       int position)
                                throws IndexOutOfBoundsException

Inserts a group at a certain position on this track

Parameters:

group - the group to be inserted

position - the index position (a value of 0 inserts at the start)

Returns:

the result of the operation

Throws:

IndexOutOfBoundsException - if the position is less than 0 or greater than the size of the track

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

removeGroup

@Nonnull
DataMutateResult removeGroup(@Nonnull
                                       Group group)

Removes a group from this track

Parameters:

group - the group to remove

Returns:

the result of the operation

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

removeGroup

@Nonnull
DataMutateResult removeGroup(@Nonnull
                                       String group)

Removes a group from this track

Parameters:

group - the group to remove

Returns:

the result of the operation

Throws:

NullPointerException - if the group is null

containsGroup

boolean containsGroup(@Nonnull
                      Group group)

Checks if a group features on this track

Parameters:

group - the group to check

Returns:

true if the group is on this track

Throws:

NullPointerException - if the group is null

IllegalStateException - if the group instance was not obtained from LuckPerms.

containsGroup

boolean containsGroup(@Nonnull
                      String group)

Checks if a group features on this track

Parameters:

group - the group to check

Returns:

true if the group is on this track

Throws:

NullPointerException - if the group is null

clearGroups

void clearGroups()

Clear all of the groups from this track