Interface Action

All Superinterfaces:

Comparable<Action>

@NonExtendable
public interface Action
extends Comparable<Action>

Represents a logged action.

API users should not implement this interface directly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Action.Builder	Builds an Action instance
static interface	Action.Source	Represents the source of an action.
static interface	Action.Target	Represents the target of an action.

Method Summary

Modifier and Type	Method	Description
static @NonNull Action.Builder	builder()	Gets a Action.Builder
@NonNull String	getDescription()	Returns a string describing the action which took place.
@NonNull Action.Source	getSource()	Gets the source of the action.
@NonNull Action.Target	getTarget()	Gets the target of the action.
@NonNull Instant	getTimestamp()	Gets the time when the action occurred.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

builder

static @NonNull Action.Builder builder()

Gets a Action.Builder

Returns:

a new builder

getTimestamp

@NonNull Instant getTimestamp()

Gets the time when the action occurred.

Returns:

the timestamp

getSource

@NonNull Action.Source getSource()

Gets the source of the action.

Returns:

the source

getTarget

@NonNull Action.Target getTarget()

Gets the target of the action.

Returns:

the target

getDescription

@NonNull String getDescription()

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