me.lucko.luckperms.api

Interface Log

@Immutable
public interface Log

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 Storage, 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
SortedSet<LogEntry>	getContent() Get the content of the log
SortedMap<Integer,LogEntry>	getGroupHistory(int pageNo, String name) Gets the log content for a given group, separated by page
SortedSet<LogEntry>	getGroupHistory(String name) Gets the log content for a given group
int	getGroupHistoryMaxPages(String name) Gets the max page number for the group history pages.
SortedSet<LogEntry>	getRecent() Get the content of the log
SortedMap<Integer,LogEntry>	getRecent(int pageNo) Gets the recent content separated by page
SortedMap<Integer,LogEntry>	getRecent(int pageNo, UUID actor) Gets the recent content for a given actor, separated by page
SortedSet<LogEntry>	getRecent(UUID actor) Gets the recent content for a given actor
int	getRecentMaxPages() Gets the max page number for the recent pages.
int	getRecentMaxPages(UUID actor) Gets the max page number for the recent pages.
SortedMap<Integer,LogEntry>	getSearch(int pageNo, String query) Gets the log content for a given search query, separated by page
SortedSet<LogEntry>	getSearch(String query) Gets the log content for a given search query
int	getSearchMaxPages(String query) Gets the max page number for the search query pages.
SortedMap<Integer,LogEntry>	getTrackHistory(int pageNo, String name) Gets the log content for a given track, separated by page
SortedSet<LogEntry>	getTrackHistory(String name) Gets the log content for a given track
int	getTrackHistoryMaxPages(String name) Gets the max page number for the track history pages.
SortedMap<Integer,LogEntry>	getUserHistory(int pageNo, UUID uuid) Gets the log content for a given user, separated by page
SortedSet<LogEntry>	getUserHistory(UUID uuid) Gets the log content for a given user
int	getUserHistoryMaxPages(UUID uuid) Gets the max page number for the user history pages.

Method Detail

getContent

@Nonnull
SortedSet<LogEntry> getContent()

Get the content of the log

Returns:

a SortedSet of all of the LogEntry objects in this Log

getRecent

@Nonnull
SortedSet<LogEntry> getRecent()

Get the content of the log

Returns:

all content in this log

getRecent

@Nonnull
SortedMap<Integer,LogEntry> getRecent(int pageNo)

Gets the recent content separated by page

Parameters:

pageNo - the page number

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getRecentMaxPages()

getRecentMaxPages

int getRecentMaxPages()

Gets the max page number for the recent pages.

Returns:

the max page number allowed in the getRecent(int) method

getRecent

@Nonnull
SortedSet<LogEntry> getRecent(@Nonnull
                                        UUID actor)

Gets the recent content for a given actor

Parameters:

actor - the uuid of the actor to filter by

Returns:

all content in this log where is actor = uuid

getRecent

@Nonnull
SortedMap<Integer,LogEntry> getRecent(int pageNo,
                                                @Nonnull
                                                UUID actor)

Gets the recent content for a given actor, separated by page

Parameters:

pageNo - the page number

actor - the uuid of the actor to filter by

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getRecentMaxPages(UUID)

getRecentMaxPages

int getRecentMaxPages(@Nonnull
                      UUID actor)

Gets the max page number for the recent pages.

Parameters:

actor - the actor to filter by

Returns:

the max page number allowed in the getRecent(int, UUID) method

getUserHistory

@Nonnull
SortedSet<LogEntry> getUserHistory(@Nonnull
                                             UUID uuid)

Gets the log content for a given user

Parameters:

uuid - the uuid to filter by

Returns:

all content in this log where the user = uuid

getUserHistory

@Nonnull
SortedMap<Integer,LogEntry> getUserHistory(int pageNo,
                                                     @Nonnull
                                                     UUID uuid)

Gets the log content for a given user, separated by page

Parameters:

pageNo - the page number

uuid - the uuid of the acted user to filter by

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getUserHistoryMaxPages(UUID)

getUserHistoryMaxPages

int getUserHistoryMaxPages(@Nonnull
                           UUID uuid)

Gets the max page number for the user history pages.

Parameters:

uuid - the uuid to filter by

Returns:

the max page number allowed in the getUserHistory(int, UUID) method

getGroupHistory

@Nonnull
SortedSet<LogEntry> 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

getGroupHistory

@Nonnull
SortedMap<Integer,LogEntry> getGroupHistory(int pageNo,
                                                      @Nonnull
                                                      String name)

Gets the log content for a given group, separated by page

Parameters:

pageNo - the page number

name - the name of the acted group to filter by

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getGroupHistoryMaxPages(String)

getGroupHistoryMaxPages

int getGroupHistoryMaxPages(@Nonnull
                            String name)

Gets the max page number for the group history pages.

Parameters:

name - the name to filter by

Returns:

the max page number allowed in the getGroupHistory(int, String) method

getTrackHistory

@Nonnull
SortedSet<LogEntry> 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

getTrackHistory

@Nonnull
SortedMap<Integer,LogEntry> getTrackHistory(int pageNo,
                                                      @Nonnull
                                                      String name)

Gets the log content for a given track, separated by page

Parameters:

pageNo - the page number

name - the name of the acted track to filter by

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getTrackHistoryMaxPages(String)

getTrackHistoryMaxPages

int getTrackHistoryMaxPages(@Nonnull
                            String name)

Gets the max page number for the track history pages.

Parameters:

name - the name to filter by

Returns:

the max page number allowed in the getTrackHistory(int, String) method

getSearch

@Nonnull
SortedSet<LogEntry> getSearch(@Nonnull
                                        String query)

Gets the log content for a given search query

Parameters:

query - the query to filter by

Returns:

all content in this log where the content matches query

getSearch

@Nonnull
SortedMap<Integer,LogEntry> getSearch(int pageNo,
                                                @Nonnull
                                                String query)

Gets the log content for a given search query, separated by page

Parameters:

pageNo - the page number

query - the query to filter by

Returns:

the page content

Throws:

IllegalArgumentException - if the pageNo is less than 1

IllegalStateException - if the log doesn't contain enough entries to populate the page. See getSearchMaxPages(String)}

getSearchMaxPages

int getSearchMaxPages(@Nonnull
                      String query)

Gets the max page number for the search query pages.

Parameters:

query - the query to filter by

Returns:

the max page number allowed in the getSearch(int, String) method