public.javadoc.org.spincast.plugins.routing.SpincastRoutingRequestContextAddon.html Maven / Gradle / Ivy

Go to download

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.

The newest version!







SpincastRoutingRequestContextAddon (org.spincast:spincast-framework 0.9.28 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.plugins.routing
Class SpincastRoutingRequestContextAddon<R extends IRequestContext<R>>



java.lang.Object


org.spincast.plugins.routing.SpincastRoutingRequestContextAddon<R>







All Implemented Interfaces:
IRoutingRequestContextAddon<R>




public class SpincastRoutingRequestContextAddon<R extends IRequestContext<R>>
extends Object
implements IRoutingRequestContextAddon<R>











Constructor Summary

Constructors 

Constructor and Description


SpincastRoutingRequestContextAddon(R requestContext) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


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



protected IRouteHandlerMatch<R>
getCurrentRouteMatch() 


int
getPosition()
The current route handler position.



protected R
getRequestContext() 


IRoutingResult<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?







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail







SpincastRoutingRequestContextAddon
@Inject
public SpincastRoutingRequestContextAddon(R requestContext)









Method Detail





getRequestContext
protected R getRequestContext()







getCurrentRouteMatch
protected IRouteHandlerMatch<R> getCurrentRouteMatch()







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

Specified by:
getPosition in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>








getCurrentRouteHandlerMatch
public IRouteHandlerMatch<R> getCurrentRouteHandlerMatch()
Description copied from interface: IRoutingRequestContextAddon
The current route handler being run (may be a filter) and its
 associated information.

Specified by:
getCurrentRouteHandlerMatch in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>








getRoutingResult
public IRoutingResult<R> getRoutingResult()
Description copied from interface: IRoutingRequestContextAddon
The routing result for the current request, 
 as returned by the router.

Specified by:
getRoutingResult in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>








isNotFoundRoute
public boolean isNotFoundRoute()
Description copied from interface: IRoutingRequestContextAddon
Are we currently on a "Not Found" routing type?

Specified by:
isNotFoundRoute in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>








isExceptionRoute
public boolean isExceptionRoute()
Description copied from interface: IRoutingRequestContextAddon
Are we currently on an "Exception" routing type?

Specified by:
isExceptionRoute in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>








isForwarded
public boolean isForwarded()
Description copied from interface: IRoutingRequestContextAddon
Is the current route forwarded?

Specified by:
isForwarded in interface IRoutingRequestContextAddon<R extends IRequestContext<R>>














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 © 2016. All rights reserved.

Modifier and Type	Method and Description
`IRouteHandlerMatch<R>`	`getCurrentRouteHandlerMatch()` The current route handler being run (may be a filter) and its associated information.
`protected IRouteHandlerMatch<R>`	`getCurrentRouteMatch()`
`int`	`getPosition()` The current route handler position.
`protected R`	`getRequestContext()`
`IRoutingResult<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?