Class PreServerListSetEvent

java.lang.Object

ch.andre601.advancedserverlist.api.velocity.events.PreServerListSetEvent

All Implemented Interfaces:

GenericServerListEvent

@NullMarked
public abstract class PreServerListSetEvent
extends Object
implements GenericServerListEvent

Called before AdvancedServerList modifies the server list.
The provided ProfileEntry will be the one used for the server list.

Constructor Summary

Constructors

Constructor	Description
PreServerListSetEvent(ProfileEntry entry)	Constructor for creating a new PreServerListSetEvent instance.

Method Summary

Modifier and Type	Method	Description
ProfileEntry	getEntry()	Gets the ProfileEntry currently set.
boolean	isCancelled()	Returns whether this event has been cancelled or not.
void	setCancelled(boolean cancelled)	Sets the event's cancel state.
void	setEntry(ProfileEntry entry)	Sets the new ProfileEntry to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PreServerListSetEvent

public PreServerListSetEvent(ProfileEntry entry)

Constructor for creating a new PreServerListSetEvent instance.

Parameters:

entry - The initial ProfileEntry to use for this event.

Method Details

getEntry

public ProfileEntry getEntry()

Gets the ProfileEntry currently set.

Specified by:

getEntry in interface GenericServerListEvent

Returns:

The currently set ProfileEntry

setEntry

public void setEntry(ProfileEntry entry)

Sets the new ProfileEntry to use.

This may not be null.

Note that a new copy of the entry will be made using ProfileEntry.copy().

Specified by:

setEntry in interface GenericServerListEvent

Parameters:

entry - The new ProfileEntry to use.

Throws:

IllegalArgumentException - When the provided ProfileEntry is null.

isCancelled

public boolean isCancelled()

Returns whether this event has been cancelled or not.

Specified by:

isCancelled in interface GenericServerListEvent

Returns:

Whether the event has been cancelled or not.

setCancelled

public void setCancelled(boolean cancelled)

Sets the event's cancel state.

Specified by:

setCancelled in interface GenericServerListEvent

Parameters:

cancelled - Boolean to set the event's cancelled state.