chore: add javadocs to CancellablePlotEvent#

This commit is contained in:
Pierre Maurice Schwang 2024-01-14 14:17:03 +01:00
parent 18bd63076f
commit 5a62cda759

View File

@ -26,8 +26,18 @@ import org.checkerframework.checker.nullness.qual.Nullable;
*/ */
public interface CancellablePlotEvent { public interface CancellablePlotEvent {
/**
* The currently set {@link Result} for this event (as set by potential previous event listeners).
*
* @return the current result.
*/
@Nullable Result getEventResult(); @Nullable Result getEventResult();
/**
* Set the {@link Result} for this event.
*
* @param eventResult the new result.
*/
void setEventResult(@Nullable Result eventResult); void setEventResult(@Nullable Result eventResult);
/** /**