Uses of Class
com.soklet.ResourcePathDeclaration

Packages that use ResourcePathDeclaration

Package	Description
com.soklet	Core Soklet contracts and functionality.

Uses of ResourcePathDeclaration in com.soklet

Methods in com.soklet that return ResourcePathDeclaration

Modifier and Type	Method	Description
static @NonNull ResourcePathDeclaration	ResourcePathDeclaration.fromPath(@NonNull String path)	Vends an instance that represents a compile-time path declaration, for example /users/{userId}.
@NonNull ResourcePathDeclaration	ResourceMethod.getResourcePathDeclaration()	Returns the HTTP path for this Resource Method, which might contain placeholders - for example, /example/{exampleId}.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerRouteKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerRouteStatusKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventCommentRouteDropKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventCommentRouteEnqueueOutcomeKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventCommentRouteKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventRouteDropKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventRouteEnqueueOutcomeKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventRouteHandshakeFailureKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventRouteKey.route()	Returns the value of the route record component.
@Nullable ResourcePathDeclaration	MetricsCollector.ServerSentEventRouteTerminationKey.route()	Returns the value of the route record component.

Methods in com.soklet with parameters of type ResourcePathDeclaration

Modifier and Type	Method	Description
default void	MetricsCollector.didBroadcastServerSentEvent(@NonNull ResourcePathDeclaration route, int attempted, int enqueued, int dropped)	Called after a broadcast attempt for a Server-Sent Event payload.
default void	MetricsCollector.didBroadcastServerSentEventComment(@NonNull ResourcePathDeclaration route, @NonNull ServerSentEventComment.CommentType commentType, int attempted, int enqueued, int dropped)	Called after a broadcast attempt for a Server-Sent Event comment payload.
@NonNull Map<@NonNull String, @NonNull String>	ResourcePath.extractPlaceholders(@NonNull ResourcePathDeclaration resourcePathDeclaration)	What is the mapping between this resource path's placeholder values to the given resource path declaration's placeholder names?
static @NonNull ResourceMethod	ResourceMethod.fromComponents(@NonNull HttpMethod httpMethod, @NonNull ResourcePathDeclaration resourcePathDeclaration, @NonNull Method method, @NonNull Boolean serverSentEventSource)	Vends a Resource Method given its unique components.
@NonNull Boolean	ResourcePath.matches(@NonNull ResourcePathDeclaration resourcePathDeclaration)	Does this resource path match the given resource path (taking placeholders/varargs into account, if present)?

Constructors in com.soklet with parameters of type ResourcePathDeclaration

Modifier	Constructor	Description
	ServerRouteKey(@NonNull HttpMethod method, @NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route)	Creates an instance of a ServerRouteKey record class.
	ServerRouteStatusKey(@NonNull HttpMethod method, @NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull String statusClass)	Creates an instance of a ServerRouteStatusKey record class.
	ServerSentEventCommentRouteDropKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull ServerSentEventComment.CommentType commentType, @NonNull MetricsCollector.ServerSentEventDropReason dropReason)	Creates an instance of a ServerSentEventCommentRouteDropKey record class.
	ServerSentEventCommentRouteEnqueueOutcomeKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull ServerSentEventComment.CommentType commentType, @NonNull MetricsCollector.ServerSentEventEnqueueOutcome outcome)	Creates an instance of a ServerSentEventCommentRouteEnqueueOutcomeKey record class.
	ServerSentEventCommentRouteKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull ServerSentEventComment.CommentType commentType)	Creates an instance of a ServerSentEventCommentRouteKey record class.
	ServerSentEventRouteDropKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull MetricsCollector.ServerSentEventDropReason dropReason)	Creates an instance of a ServerSentEventRouteDropKey record class.
	ServerSentEventRouteEnqueueOutcomeKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull MetricsCollector.ServerSentEventEnqueueOutcome outcome)	Creates an instance of a ServerSentEventRouteEnqueueOutcomeKey record class.
	ServerSentEventRouteHandshakeFailureKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull ServerSentEventConnection.HandshakeFailureReason handshakeFailureReason)	Creates an instance of a ServerSentEventRouteHandshakeFailureKey record class.
	ServerSentEventRouteKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route)	Creates an instance of a ServerSentEventRouteKey record class.
	ServerSentEventRouteTerminationKey(@NonNull MetricsCollector.RouteType routeType, @Nullable ResourcePathDeclaration route, @NonNull ServerSentEventConnection.TerminationReason terminationReason)	Creates an instance of a ServerSentEventRouteTerminationKey record class.