me.lucko.luckperms.api

Interface LogEntry

All Superinterfaces:

Comparable<LogEntry>

public interface LogEntry
extends Comparable<LogEntry>

Represents a logged action.

See Also:

for creating an instance

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LogEntry.Builder Builds a LogEntry instance
static class	LogEntry.Type Represents the type of a LogEntry.

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<UUID>	getActed() Gets the uuid of the object which was acted upon.
@NonNull String	getActedName() Gets the name describing the object which was acted upon
@NonNull String	getAction() Returns a string describing the action which took place.
@NonNull UUID	getActor() Gets the id of the object which performed the action.
@NonNull String	getActorName() Gets the name describing the actor.
long	getTimestamp() Gets the time in unix seconds when the action occurred.
@NonNull LogEntry.Type	getType() Gets the type of action.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getTimestamp

long getTimestamp()

Gets the time in unix seconds when the action occurred.

Returns:

the timestamp

getActor

@NonNull UUID getActor()

Gets the id of the object which performed the action.

This is the players uuid in most cases.

Returns:

the actor id

getActorName

@NonNull String getActorName()

Gets the name describing the actor.

Returns:

the name of the actor

getType

@NonNull LogEntry.Type getType()

Gets the type of action.

Returns:

the action type

getActed

@NonNull Optional<UUID> getActed()

Gets the uuid of the object which was acted upon.

Will only return a value for LogEntry.Type.USER entries.

Returns:

the uuid of acted object

getActedName

@NonNull String getActedName()

Gets the name describing the object which was acted upon

Returns:

the name of the acted object

getAction

@NonNull String getAction()

Returns a string describing the action which took place.

In most instances, this returns a variation of the command string which caused the change.

Returns:

the action