Package net.minestom.server.event

Interface EventFilter<E extends Event,H>

Type Parameters:

E - The event type to filter

H - The handler type to filter on.

public interface EventFilter<E extends Event,H>

Represents a filter for a specific Event type.

The handler represents a "target" of the event. This can be used to create filters for all events of a specific type using information about the target.

For example, the target of a PlayerEvent is a Player so you could create a player event filter which checks if the target player is in creative mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final EventFilter<Event,?>	ALL
static final EventFilter<BlockEvent,Block>	BLOCK
static final EventFilter<EntityEvent,Entity>	ENTITY
static final EventFilter<InstanceEvent,Instance>	INSTANCE
static final EventFilter<InventoryEvent,Inventory>	INVENTORY
static final EventFilter<ItemEvent,ItemStack>	ITEM
static final EventFilter<PlayerEvent,Player>	PLAYER

Method Summary

Modifier and Type	Method	Description
default H	castHandler(@NotNull Object event)
@NotNull Class<E>	eventType()	The event type to filter on.
static <E extends Event, H> EventFilter<E,H>	from(@NotNull Class<E> eventType, @Nullable Class<H> handlerType, @Nullable Function<E,H> handlerGetter)
H	getHandler(E event)	Gets the handler for the given event instance, or null if the event type has no handler.
@Nullable Class<H>	handlerType()	The type returned by getHandler(Event).

Field Details

ALL

static final EventFilter<Event,?> ALL

ENTITY

static final EventFilter<EntityEvent,Entity> ENTITY

PLAYER

static final EventFilter<PlayerEvent,Player> PLAYER

ITEM

static final EventFilter<ItemEvent,ItemStack> ITEM

INSTANCE

static final EventFilter<InstanceEvent,Instance> INSTANCE

INVENTORY

static final EventFilter<InventoryEvent,Inventory> INVENTORY

BLOCK

static final EventFilter<BlockEvent,Block> BLOCK

Method Details

from

static <E extends Event,
H> EventFilter<E,H> from(@NotNull
 @NotNull Class<E> eventType,
 @Nullable
 @Nullable Class<H> handlerType,
 @Nullable
 @Nullable Function<E,H> handlerGetter)

getHandler

@Nullable
H getHandler(@NotNull
 E event)

Gets the handler for the given event instance, or null if the event type has no handler.

Parameters:

event - The event instance

Returns:

The handler, if it exists for the given event

castHandler

@Internal
@Nullable
default H castHandler(@NotNull
 @NotNull Object event)

eventType

@NotNull
@NotNull Class<E> eventType()

The event type to filter on.

Returns:

The event type.

handlerType

@Nullable
@Nullable Class<H> handlerType()

The type returned by getHandler(Event).

Returns:

the handler type, null if not any