org.apache.velocity.util.introspection.VelMethod Maven / Gradle / Ivy
The newest version!
package org.apache.velocity.util.introspection;
/*
* 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.
*/
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
/**
* Method used for regular method invocation
*
* $foo.bar()
*
*
* @author Geir Magnusson Jr.
* @version $Id$
*/
public interface VelMethod
{
/**
* invocation method - called when the method invocation should be
* performed and a value returned
* @param o
* @param params
* @return The resulting object.
* @throws IllegalAccessException
* @throws InvocationTargetException
*/
Object invoke(Object o, Object[] params)
throws IllegalAccessException, InvocationTargetException;
/**
* specifies if this VelMethod is cacheable and able to be
* reused for this class of object it was returned for
*
* @return true if can be reused for this class, false if not
*/
boolean isCacheable();
/**
* returns the method name used
* @return The method name used
*/
String getMethodName();
/**
* returns the underlying Method
* @return the method
* @since 2.0
*/
Method getMethod();
/**
* returns the return type of the method invoked
* @return The return type of the method invoked
*/
Class getReturnType();
}