ClassTool.MethodSub (VelocityTools 2.0 Documentation)

java.lang.Object
- org.apache.velocity.tools.generic.ClassTool.Sub<T>
- - org.apache.velocity.tools.generic.ClassTool.CallableSub<ClassTool.MethodSub>
  - - org.apache.velocity.tools.generic.ClassTool.MethodSub

All Implemented Interfaces:

java.lang.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.

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.reflect.Method method
- Fields inherited from class org.apache.velocity.tools.generic.ClassTool.CallableSub
  javadocRef, signature, uniqueName

Fields
Modifier and Type	Field and Description
`protected java.lang.reflect.Method`	`method`

Constructor Summary

Constructors
Constructor and Description

MethodSub(java.lang.reflect.Method method)

Constructors
Constructor and Description
`MethodSub(java.lang.reflect.Method method)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.reflect.AnnotatedElement`	`getElement()`
`protected int`	`getModifiers()`
`java.lang.String`	`getName()`
`java.lang.Class[]`	`getParameters()`
`java.lang.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.
`java.lang.Class`	`getReturns()`
`protected java.lang.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.
`private java.lang.String`	`uncapitalize(java.lang.String string)`

Methods inherited from class org.apache.velocity.tools.generic.ClassTool.CallableSub
getJavadocRef, getParameterCount, getSignature, getUniqueName, signature, takesParameters

Methods inherited from class org.apache.velocity.tools.generic.ClassTool.Sub
compareTo, equals, getAnnotations, hashCode, isAbstract, isDeprecated, isFinal, isInterface, isNative, isPrivate, isProtected, isPublic, isStatic, isStrict, isSynchronized, isTransient, isVolatile, toString

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

- Field Detail
  - method
```
protected java.lang.reflect.Method method
```
- Constructor Detail
  - MethodSub
```
public MethodSub(java.lang.reflect.Method method)
```
- Method Detail
  - getElement
```
protected java.lang.reflect.AnnotatedElement getElement()
```
    Specified by:
    
    getElement in class ClassTool.Sub<ClassTool.MethodSub>
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in class ClassTool.Sub<ClassTool.MethodSub>
  - getPropertyName
```
public java.lang.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")
  - uncapitalize
```
private java.lang.String uncapitalize(java.lang.String string)
```
  - 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>
  - isVoid
```
public boolean isVoid()
```
    Returns true if the return type of this method is void.
  - getReturns
```
public java.lang.Class getReturns()
```
  - getParameters
```
public java.lang.Class[] getParameters()
```
    Specified by:
    
    getParameters in class ClassTool.CallableSub<ClassTool.MethodSub>
  - getModifiers
```
protected int getModifiers()
```
    Specified by:
    
    getModifiers in class ClassTool.Sub<ClassTool.MethodSub>
  - getSubType
```
protected java.lang.String getSubType()
```
    Specified by:
    
    getSubType in class ClassTool.Sub<ClassTool.MethodSub>

Class ClassTool.MethodSub

Field Summary

Fields inherited from class org.apache.velocity.tools.generic.ClassTool.CallableSub

Constructor Summary

Method Summary

Methods inherited from class org.apache.velocity.tools.generic.ClassTool.CallableSub

Methods inherited from class org.apache.velocity.tools.generic.ClassTool.Sub

Methods inherited from class java.lang.Object

Field Detail

method

Constructor Detail

MethodSub

Method Detail

getElement

getName

getPropertyName

uncapitalize

isVarArgs

isVoid

getReturns

getParameters

getModifiers

getSubType