| java.lang.Object
 org.apache.velocity.app.event.EventHandlerUtil
| EventHandlerUtil | | public class EventHandlerUtil (Code) | | Calls on request all registered event handlers for a particular event. Each
method accepts two event cartridges (typically one from the application and
one from the context). All appropriate event handlers are executed in order
until a stopping condition is met. See the docs for the individual methods to
see what the stopping condition is for that method.
author:
Will Glass-Husain
version:
$Id: EventHandlerUtil.java 470256 2006-11-02 07:20:36Z wglass $ |
| Method Summary | |
| public static String | includeEvent(RuntimeServices rsvc, InternalContextAdapter context, String includeResourcePath, String currentResourcePath, String directiveName)
Called when an include-type directive is encountered (#include or
#parse). | | public static Object | invalidGetMethod(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object object, String property, Info info)
Called when an invalid get method is encountered. | | public static Object | invalidMethod(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object object, String method, Info info)
Called when an invalid method is encountered. | | public static Object | invalidReferenceHandlerCall(EventHandlerMethodExecutor methodExecutor, RuntimeServices rsvc, InternalContextAdapter context)
Calls event handler method with appropriate chaining across event handlers. | | public static void | invalidSetMethod(RuntimeServices rsvc, InternalContextAdapter context, String leftreference, String rightreference, Info info)
Called when an invalid set method is encountered. | | public static Object | methodException(RuntimeServices rsvc, InternalContextAdapter context, Class claz, String method, Exception e)
Called when a method exception is generated during Velocity merge. | | public static Object | referenceInsert(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object value)
Called before a reference is inserted. | | public static boolean | shouldLogOnNullSet(RuntimeServices rsvc, InternalContextAdapter context, String lhs, String rhs)
Called when a null is evaluated during a #set. |
| includeEvent | | public static String includeEvent(RuntimeServices rsvc, InternalContextAdapter context, String includeResourcePath, String currentResourcePath, String directiveName)(Code) | | Called when an include-type directive is encountered (#include or
#parse). All the registered event handlers are called unless null is
returned. The default implementation always processes the included
resource.
Parameters:
includeResourcePath - the path as given in the include directive.
Parameters:
currentResourcePath - the path of the currently rendering template that includes theinclude directive.
Parameters:
directiveName - name of the directive used to include the resource. (With thestandard directives this is either "parse" or "include").
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - The internal context adapter. a new resource path for the directive, or null to block theinclude from occurring. |
| invalidGetMethod | | public static Object invalidGetMethod(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object object, String property, Info info)(Code) | | Called when an invalid get method is encountered.
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - the context when the reference was found invalid
Parameters:
reference - complete invalid reference
Parameters:
object - object from reference, or null if not available
Parameters:
property - name of property, or null if not relevant
Parameters:
info - contains info on template, line, col substitute return value for missing reference, or null if no substitute |
| invalidMethod | | public static Object invalidMethod(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object object, String method, Info info)(Code) | | Called when an invalid method is encountered.
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - the context when the reference was found invalid
Parameters:
reference - complete invalid reference
Parameters:
object - object from reference, or null if not available
Parameters:
method - name of method, or null if not relevant
Parameters:
info - contains info on template, line, col substitute return value for missing reference, or null if no substitute |
| invalidReferenceHandlerCall | | public static Object invalidReferenceHandlerCall(EventHandlerMethodExecutor methodExecutor, RuntimeServices rsvc, InternalContextAdapter context)(Code) | | Calls event handler method with appropriate chaining across event handlers.
Parameters:
methodExecutor -
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - The current context return value from method, or null if no return value |
| invalidSetMethod | | public static void invalidSetMethod(RuntimeServices rsvc, InternalContextAdapter context, String leftreference, String rightreference, Info info)(Code) | | Called when an invalid set method is encountered.
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - the context when the reference was found invalid
Parameters:
leftreference - left reference being assigned to
Parameters:
rightreference - invalid reference on the right
Parameters:
info - contains info on template, line, col |
| methodException | | public static Object methodException(RuntimeServices rsvc, InternalContextAdapter context, Class claz, String method, Exception e) throws Exception(Code) | | Called when a method exception is generated during Velocity merge. Only
the first valid event handler in the sequence is called. The default
implementation simply rethrows the exception.
Parameters:
claz - Class that is causing the exception
Parameters:
method - method called that causes the exception
Parameters:
e - Exception thrown by the method
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - The internal context adapter. Object to return as method result
throws:
Exception - to be wrapped and propogated to app |
| referenceInsert | | public static Object referenceInsert(RuntimeServices rsvc, InternalContextAdapter context, String reference, Object value)(Code) | | Called before a reference is inserted. All event handlers are called in
sequence. The default implementation inserts the reference as is.
Parameters:
reference - reference from template about to be inserted
Parameters:
value - value about to be inserted (after toString() )
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - The internal context adapter. Object on which toString() should be called for output. |
| shouldLogOnNullSet | | public static boolean shouldLogOnNullSet(RuntimeServices rsvc, InternalContextAdapter context, String lhs, String rhs)(Code) | | Called when a null is evaluated during a #set. All event handlers are
called in sequence until a false is returned. The default implementation
always returns true.
Parameters:
lhs - Left hand side of the expression.
Parameters:
rhs - Right hand side of the expression.
Parameters:
rsvc - current instance of RuntimeServices
Parameters:
context - The internal context adapter. true if to be logged, false otherwise |
|
|