Class JavaMethod

Method Details

• getReturns

  public Type getReturns()

  Deprecated.

  it is recommended to use getReturnType()

  Returns:

  the return type

• getParameters

  public JavaParameter[] getParameters()

• getParameterByName

  public JavaParameter getParameterByName(String name)

• getExceptions

  public Type[] getExceptions()

• isConstructor

  public boolean isConstructor()

  Returns:

  true is this method is a constructor

• isVarArgs

  public boolean isVarArgs()

  Returns:

  true is this method conains varArgs

• writeBody

  protected void writeBody(IndentBuffer result)

  Specified by:

  writeBody in class AbstractJavaEntity

• writeBody

  protected void writeBody(IndentBuffer result, boolean withModifiers, boolean isDeclaration, boolean isPrettyPrint)

  Since:

  1.3

• getDeclarationSignature

  public String getDeclarationSignature(boolean withModifiers)

  Specified by:

  getDeclarationSignature in interface Member

  Since:

  1.3

• getCallSignature

  public String getCallSignature()

  Specified by:

  getCallSignature in interface Member

  Since:

  1.3

• setReturns

  public void setReturns(Type returns)

  Define the return type of this method

  Parameters:

  returns - the return type

• addParameter

  public void addParameter(JavaParameter javaParameter)

• setExceptions

  public void setExceptions(Type[] exceptions)

• setConstructor

  public void setConstructor(boolean constructor)

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• signatureMatches

  public boolean signatureMatches(String name, Type[] parameterTypes)

  Deprecated.

  use overloaded method

  This method is NOT varArg aware. The overloaded method is.

  Parameters:

  name -

  parameterTypes -

  Returns:

• signatureMatches

  public boolean signatureMatches(String name, Type[] parameterTypes, boolean varArg)

  Parameters:

  name - method name

  parameterTypes - parameter types or null if there are no parameters.

  Returns:

  true if the signature and parameters match.

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• isPublic

  public boolean isPublic()

  Overrides:

  isPublic in class AbstractJavaEntity

• isPropertyAccessor

  public boolean isPropertyAccessor()

  Returns:

  true if this method is a Java Bean accessor

  Since:

  1.3

• isPropertyMutator

  public boolean isPropertyMutator()

  Returns:

  true if this method is a Java Bean accessor

  Since:

  1.3

• getPropertyType

  public Type getPropertyType()

  Returns:

  the type of the property this method represents, or null if this method is not a property mutator or property accessor.

  Since:

  1.3

• getPropertyName

  public String getPropertyName()

  Returns:

  the name of the property this method represents, or null if this method is not a property mutator or property accessor.

  Since:

  1.3

• getTagsByName

  public DocletTag[] getTagsByName(String name, boolean inherited)

  Specified by:

  getTagsByName in class AbstractInheritableJavaEntity

• compareTo

  public int compareTo(Object o)

  Specified by:

  compareTo in interface Comparable

• getSourceCode

  public String getSourceCode()

  Get the original source code of the body of this method.

  Returns:

  Code as string.

• setSourceCode

  public void setSourceCode(String sourceCode)

• setTypeParameters

  public void setTypeParameters(TypeVariable[] typeParameters)

• getTypeParameters

  public TypeVariable[] getTypeParameters()

• toString

  public String toString()

  Overrides:

  toString in class Object

• getGenericReturnType

  public Type getGenericReturnType()

  Equivalent of java.lang.reflect.Method.getGenericReturnType()

  Returns:

  the generic returntype

  Since:

  1.12

• getReturnType

  public Type getReturnType()

  Equivalent of java.lang.reflect.Method.getReturnType()

  Returns:

  Since:

  1.12

• getReturnType

  public Type getReturnType(boolean resolve)

  If a class inherits this method from a generic class or interface, you can use this method to get the resolved return type

  Parameters:

  resolve -

  Returns:

  Since:

  1.12

• getReturnType

  protected Type getReturnType(boolean resolve, JavaClass callingClass)

  Parameters:

  resolve -

  callingClass -

  Returns:

  Since:

  1.12

• getParameterTypes

  public Type[] getParameterTypes()

  Returns:

  the parameter types as array

  Since:

  1.12

• getParameterTypes

  public Type[] getParameterTypes(boolean resolve)

  If a class inherits this method from a generic class or interface, you can use this method to get the resolved parameter types

  Parameters:

  resolve -

  Returns:

  the parameter types as array

  Since:

  1.12

• getParameterTypes

  protected Type[] getParameterTypes(boolean resolve, JavaClass callingClass)