net.luckperms.api.actionlog

Interface ActionLog

public interface ActionLog

Represents the internal LuckPerms log.

The returned instance provides a copy of the data at the time of retrieval.

Any changes made to log entries will only apply to this instance of the log. You can add to the log using the ActionLogger, and then request an updated copy.

All methods are thread safe, and return immutable and thread safe collections.

Method Summary

Modifier and Type	Method and Description
@NonNull SortedSet<Action>	getContent() Gets the Actions that make up this log.
@NonNull SortedSet<Action>	getContent(@NonNull UUID actor) Gets the entries in the log performed by the given actor.
@NonNull SortedSet<Action>	getGroupHistory(@NonNull String name) Gets the log content for a given group
@NonNull SortedSet<Action>	getTrackHistory(@NonNull String name) Gets the log content for a given track
@NonNull SortedSet<Action>	getUserHistory(@NonNull UUID uniqueId) Gets the log content for a given user

Method Detail

getContent

@NonNull SortedSet<Action> getContent()

Gets the Actions that make up this log.

Returns:

the content

getContent

@NonNull SortedSet<Action> getContent(@NonNull UUID actor)

Gets the entries in the log performed by the given actor.

Parameters:

actor - the uuid of the actor to filter by

Returns:

the content for the given actor

getUserHistory

@NonNull SortedSet<Action> getUserHistory(@NonNull UUID uniqueId)

Gets the log content for a given user

Parameters:

uniqueId - the uuid to filter by

Returns:

all content in this log where the user = uuid

getGroupHistory

@NonNull SortedSet<Action> getGroupHistory(@NonNull String name)

Gets the log content for a given group

Parameters:

name - the name to filter by

Returns:

all content in this log where the group = name

getTrackHistory

@NonNull SortedSet<Action> getTrackHistory(@NonNull String name)

Gets the log content for a given track

Parameters:

name - the name to filter by

Returns:

all content in this log where the track = name