Class ClassTool.MethodSub

java.lang.Object

org.apache.velocity.tools.generic.ClassTool.Sub<ClassTool.MethodSub>

org.apache.velocity.tools.generic.ClassTool.CallableSub<ClassTool.MethodSub>

org.apache.velocity.tools.generic.ClassTool.MethodSub

All Implemented Interfaces:

Comparable<ClassTool.MethodSub>

Enclosing class:

ClassTool

public static class ClassTool.MethodSub
extends ClassTool.CallableSub<ClassTool.MethodSub>

A simplified wrapping interface for inspecting features of a Method in an inspected Class.

Since:

VelocityTools 2.0

Version:

$Id: ClassTool.java 463298 2006-10-12 16:10:32Z henning $

Author:

Nathan Bubna

Field Summary

Fields

Modifier and Type	Field	Description
protected Method	method

Fields inherited from class ClassTool.CallableSub

javadocRef, signature, uniqueName

Constructor Summary

Constructors

Constructor	Description
MethodSub(Method method)	Method inspector constructor

Method Summary

Modifier and Type	Method	Description
protected AnnotatedElement	getElement()
protected int	getModifiers()
String	getName()
Class[]	getParameters()
String	getPropertyName()	If this method can be treated as a bean property in Velocity (which does not exactly follow the javabean spec for such things) then it will return the "bean property" equivalent of the method name.
Class	getReturns()
protected String	getSubType()
boolean	isVarArgs()	Returns true if the final parameter for the method was declared as a vararg.
boolean	isVoid()	Returns true if the return type of this method is void.

Methods inherited from class ClassTool.CallableSub

getJavadocRef, getParameterCount, getSignature, getUniqueName, signature, takesParameters

Methods inherited from class ClassTool.Sub

compareTo, equals, getAnnotations, hashCode, isAbstract, isDeprecated, isFinal, isInterface, isNative, isPrivate, isProtected, isPublic, isStatic, isStrict, isSynchronized, isTransient, isVolatile, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

method

protected Method method

Constructor Details

MethodSub

public MethodSub(Method method)

Method inspector constructor

Parameters:

method - methodto inspect

Method Details

getElement

protected AnnotatedElement getElement()

Specified by:

getElement in class ClassTool.Sub<ClassTool.MethodSub>

Returns:

inspected element

getName

public String getName()

Specified by:

getName in class ClassTool.Sub<ClassTool.MethodSub>

Returns:

method name

getPropertyName

public String getPropertyName()

If this method can be treated as a bean property in Velocity (which does not exactly follow the javabean spec for such things) then it will return the "bean property" equivalent of the method name. (e.g. for getFoo(), isFoo() or setFoo(foo) it will return "foo")

Returns:

related property name, or null

isVarArgs

public boolean isVarArgs()

Returns true if the final parameter for the method was declared as a vararg.

Specified by:

isVarArgs in class ClassTool.CallableSub<ClassTool.MethodSub>

Returns:

vararg status

isVoid

public boolean isVoid()

Returns true if the return type of this method is void.

Returns:

true if the inspected method returns null

getReturns

public Class getReturns()

Returns:

inspected method return type

getParameters

public Class[] getParameters()

Specified by:

getParameters in class ClassTool.CallableSub<ClassTool.MethodSub>

Returns:

inspected method parameters types

getModifiers

protected int getModifiers()

Specified by:

getModifiers in class ClassTool.Sub<ClassTool.MethodSub>

Returns:

inspected method modifiers

getSubType

protected String getSubType()

Specified by:

getSubType in class ClassTool.Sub<ClassTool.MethodSub>

Returns:

inspector type, aka "method"