Package de.craftsblock.craftsnet.events.requests.routes

Class RouteRequestEvent

java.lang.Object

de.craftsblock.craftscore.event.Event

de.craftsblock.craftscore.event.CancellableEvent

de.craftsblock.craftsnet.events.EventWithCancelReason

de.craftsblock.craftsnet.events.requests.routes.RouteRequestEvent

All Implemented Interfaces:

de.craftsblock.craftscore.event.Cancellable, GenericRequestEventBase

public class RouteRequestEvent
extends EventWithCancelReason
implements GenericRequestEventBase

The RouteRequestEvent class represents an event related to a route request. This class provides information about the Exchange and the RouteRegistry.EndpointMapping involved in the request event.

Since:

1.0.0-SNAPSHOT

See Also:

• EventWithCancelReason
• GenericRequestEventBase

Constructor Summary

Constructors

Constructor	Description
RouteRequestEvent(Exchange exchange)	Constructs a new RouteRequestEvent with the specified Exchange and RouteRegistry.EndpointMapping.

Method Summary

Modifier and Type	Method	Description
@NotNull Exchange	getExchange()	Gets the Exchange which stores the involved request, response and some other data.
Collection<RouteRegistry.EndpointMapping>	getMappings()	Get a list of RouteRegistry.EndpointMapping associated with the request event.
boolean	hasMappings()	Checks if the request event has at least one valid RouteRegistry.EndpointMapping associated with it.

Methods inherited from class de.craftsblock.craftsnet.events.EventWithCancelReason

getCancelReason, hasCancelReason, setCancelReason

Methods inherited from class de.craftsblock.craftscore.event.CancellableEvent

isCancelled, setCancelled

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.craftsblock.craftsnet.events.requests.GenericRequestEventBase

getRequest, getResponse

Constructor Details

RouteRequestEvent

public RouteRequestEvent(Exchange exchange)

Constructs a new RouteRequestEvent with the specified Exchange and RouteRegistry.EndpointMapping.

Parameters:

exchange - The Exchange object representing the request and its associated data.

Method Details

getExchange

@NotNull
public @NotNull Exchange getExchange()

Gets the Exchange which stores the involved request, response and some other data.

Specified by:

getExchange in interface GenericRequestEventBase

Returns:

The Exchange.

getMappings

public Collection<RouteRegistry.EndpointMapping> getMappings()

Get a list of RouteRegistry.EndpointMapping associated with the request event.

Returns:

A list of RouteRegistry.EndpointMapping representing the mappings for the request route.

hasMappings

public boolean hasMappings()

Checks if the request event has at least one valid RouteRegistry.EndpointMapping associated with it.

Returns:

true if the event has at least one valid RouteRegistry.EndpointMapping, false otherwise.