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.

Field Summary

Fields

Modifier and Type

Field

Description

protected Method

method

Fields inherited from class org.apache.velocity.tools.generic.ClassTool.CallableSub
javadocRef, signature, uniqueName
Constructor Summary

Constructors

Constructor

Description

MethodSub(Method method)
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.

private String

uncapitalize(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 Details
- method
  
  protected Method method
Constructor Details
- MethodSub
  
  public MethodSub(Method method)
Method Details
- getElement
  
  protected AnnotatedElement getElement()
  
  Specified by:
  
  getElement in class ClassTool.Sub<ClassTool.MethodSub>
- getName
  
  public String getName()
  
  Specified by:
  
  getName in class ClassTool.Sub<ClassTool.MethodSub>
- 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")
- uncapitalize
  
  private String uncapitalize(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 Class getReturns()
- getParameters
  
  public 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 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 Details

method

Constructor Details

MethodSub

Method Details

getElement

getName

getPropertyName

uncapitalize

isVarArgs

isVoid

getReturns

getParameters

getModifiers

getSubType