public.javadoc.org.spincast.core.routing.RoutingRequestContextAddon.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







RoutingRequestContextAddon (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.core.routing
Interface RoutingRequestContextAddon<R extends RequestContext<?>>






All Known Implementing Classes:
SpincastRoutingRequestContextAddon




public interface RoutingRequestContextAddon<R extends RequestContext<?>>
Add-on to get information about
 the current routing process.











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


RouteHandlerMatch<R>
getCurrentRouteHandlerMatch()
The current route handler being run (may be a filter) and its
 associated information.



int
getPosition()
The current route handler position.



RoutingResult<R>
getRoutingResult()
The routing result for the current request, 
 as returned by the router.



boolean
isExceptionRoute()
Are we currently on an "Exception" routing type?



boolean
isForwarded()
Is the current route forwarded?



boolean
isNotFoundRoute()
Are we currently on a "Not Found" routing type?
















Method Detail





isNotFoundRoute
boolean isNotFoundRoute()
Are we currently on a "Not Found" routing type?







isExceptionRoute
boolean isExceptionRoute()
Are we currently on an "Exception" routing type?







isForwarded
boolean isForwarded()
Is the current route forwarded?







getCurrentRouteHandlerMatch
RouteHandlerMatch<R> getCurrentRouteHandlerMatch()
The current route handler being run (may be a filter) and its
 associated information.







getRoutingResult
RoutingResult<R> getRoutingResult()
The routing result for the current request, 
 as returned by the router.







getPosition
int getPosition()
The current route handler position. 
 If < 0 : is a "before" handler.
 If == 0 : is the main handler.
 If > 0 : is an "after" handler.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

Modifier and Type	Method and Description
`RouteHandlerMatch<R>`	`getCurrentRouteHandlerMatch()` The current route handler being run (may be a filter) and its associated information.
`int`	`getPosition()` The current route handler position.
`RoutingResult<R>`	`getRoutingResult()` The routing result for the current request, as returned by the router.
`boolean`	`isExceptionRoute()` Are we currently on an "Exception" routing type?
`boolean`	`isForwarded()` Is the current route forwarded?
`boolean`	`isNotFoundRoute()` Are we currently on a "Not Found" routing type?