org.apache.velocity.app.event.MethodExceptionEventHandler Maven / Gradle / Ivy
The newest version!
package org.apache.velocity.app.event;
import org.apache.velocity.context.Context;
import org.apache.velocity.util.introspection.Info;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Event handler called when a method throws an exception. This gives the
* application a chance to deal with it and either
* return something nice, or throw.
*
* Please return what you want rendered into the output stream.
*
* @author Will Glass-Husain
* @author Geir Magnusson Jr.
* @version $Id$
*/
public interface MethodExceptionEventHandler extends EventHandler
{
/**
* Called when a method throws an exception.
* Only the first registered MethodExceptionEventHandler is called. If
* none are registered a MethodInvocationException is thrown.
*
* @param context current context
* @param claz the class of the object the method is being applied to
* @param method the method
* @param e the thrown exception
* @param info contains template, line, column details
* @return an object to insert in the page
* @throws RuntimeException an exception to be thrown instead inserting an object
*/
Object methodException(Context context, Class claz, String method, Exception e, Info info);
}