JMethod (Castor JavaDoc)

java.lang.Object
- org.exolab.javasource.JMethod

All Implemented Interfaces:

JAnnotatedElement, JMember
```
public final class JMethod
extends java.lang.Object
implements JMember, JAnnotatedElement
```
A class which holds information about the methods of a JClass. Modelled closely after the Java Reflection API. This class is part of package which is used to create source code.

Version:

$Revision: 6324 $ $Date: 2004-12-03 11:57:33 -0700 (Fri, 03 Dec 2004) $

Author:

Keith Visco

Constructor Summary

Constructors
Constructor and Description
`JMethod(java.lang.String name)` Creates a new JMethod with the given name and "void" return type.
`JMethod(java.lang.String name, JType returnType, java.lang.String returnDoc)` Creates a new JMethod with the given name and returnType.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(JAnnotation annotation)` Adds a JAnnotation to this source element.
`protected void`	`addDeclaringClass(JClass jClass)` Adds the given JClass to the set of classes that contain this method.
`void`	`addException(JClass exp, java.lang.String description)` Adds the given Exception to this JMethod's throws clause.
`void`	`addParameter(JParameter parameter)` Adds the given parameter to this JMethod's list of parameters.
`JAnnotation`	`getAnnotation(JAnnotationType annotationType)` Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
`JAnnotation[]`	`getAnnotations()` Returns a list of JAnnotation's already set on this source element.
`JClass[]`	`getExceptions()` Returns the exceptions that this JMethod throws.
`JDocComment`	`getJDocComment()` Returns the JavaDoc comment describing this JMethod.
`JModifiers`	`getModifiers()` Returns the modifiers for this JMethod.
`java.lang.String`	`getName()` Returns the name of this JMethod.
`JParameter`	`getParameter(int index)` Returns the JParameter at the given index.
`protected java.lang.String[]`	`getParameterClassNames()` Return the list of class names representing the parameters.
`JParameter[]`	`getParameters()` Returns the set of JParameters for this JMethod.
`JType`	`getReturnType()` Returns the JType that represents the return type of the JMethod.
`JMethodSignature`	`getSignature()` Returns the JMethodSignature for this JMethod.
`JSourceCode`	`getSourceCode()` Returns the JSourceCode for the method body.
`boolean`	`hasAnnotations()` Returns true if this source element has any annotations.
`boolean`	`isAnnotationPresent(JAnnotationType annotationType)` Returns true if a JAnnotation exists for the given JAnnotationType.
`void`	`print(JSourceWriter jsw)` Prints this JMethod to the given JSourceWriter.
`JAnnotation`	`removeAnnotation(JAnnotationType annotationType)` Removes the JAnnotation from this source element for the given JAnnotationType.
`protected void`	`removeDeclaringClass(JClass jClass)` Removes the given JClass from the set of classes that contain this method.
`void`	`setComment(java.lang.String comment)` Sets the comment describing this JMethod.
`void`	`setModifiers(JModifiers modifiers)` Sets the JModifiers for this JMethod.
`void`	`setName(java.lang.String name)` Sets the name of this JMethod.
`void`	`setSourceCode(JSourceCode source)` Sets the given JSourceCode as the source code (method body) for this JMethod.
`void`	`setSourceCode(java.lang.String source)` Sets the given string as the source code (method body) for this JMethod.
`java.lang.String`	`toString()` Returns the String representation of this JMethod, which is the method prototype.

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

- Constructor Detail
  - JMethod
```
public JMethod(java.lang.String name)
```
    Creates a new JMethod with the given name and "void" return type.
    
    Parameters:
    
    name - the method name. Must not be null.
  - JMethod
```
public JMethod(java.lang.String name,
               JType returnType,
               java.lang.String returnDoc)
```
    Creates a new JMethod with the given name and returnType. The return type must not be empty or null. For "void" return types, use JMethod(String) instead of this constructor.
    
    Parameters:
    
    name - the method name. Must not be null.
    
    returnType - the return type of the method. Must not be null.
    
    returnDoc - javadoc comment for the @return annotation. If null, a default (and mostly useless) javadoc comment will be generated.
- Method Detail
  - addException
```
public void addException(JClass exp,
                         java.lang.String description)
```
    Adds the given Exception to this JMethod's throws clause.
    
    Parameters:
    
    exp - the JClass representing the Exception
    
    description - JavaDoc comment explaining when this exception is thrown
  - addParameter
```
public void addParameter(JParameter parameter)
```
    Adds the given parameter to this JMethod's list of parameters.
    
    Parameters:
    
    parameter - the parameter to add to the this JMethod's list of parameters.
  - getJDocComment
```
public JDocComment getJDocComment()
```
    Returns the JavaDoc comment describing this JMethod.
    
    Returns:
    
    the JavaDoc comment describing this JMethod.
  - getExceptions
```
public JClass[] getExceptions()
```
    Returns the exceptions that this JMethod throws.
    
    Returns:
    
    the exceptions that this JMethod throws.
  - getModifiers
```
public JModifiers getModifiers()
```
    Returns the modifiers for this JMethod.
    
    Specified by:
    
    getModifiers in interface JMember
    
    Returns:
    
    the modifiers for this JMethod.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this JMethod.
    
    Specified by:
    
    getName in interface JMember
    
    Returns:
    
    the name of this JMethod.
  - getParameter
```
public JParameter getParameter(int index)
```
    Returns the JParameter at the given index.
    
    Parameters:
    
    index - the index of the JParameter to return
    
    Returns:
    
    the JParameter at the given index.
  - getParameters
```
public JParameter[] getParameters()
```
    Returns the set of JParameters for this JMethod.
    Note: the array is a copy, the parameters in the array are the actual references
    
    Returns:
    
    the set of JParameters for this JMethod.
  - getReturnType
```
public JType getReturnType()
```
    Returns the JType that represents the return type of the JMethod.
    
    Returns:
    
    the JType that represents the return type of the JMethod.
  - getSignature
```
public JMethodSignature getSignature()
```
    Returns the JMethodSignature for this JMethod.
    
    Returns:
    
    the JMethodSignature for this JMethod.
  - getSourceCode
```
public JSourceCode getSourceCode()
```
    Returns the JSourceCode for the method body.
    
    Returns:
    
    the JSourceCode for the method body.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this JMethod.
    
    Parameters:
    
    name - the name of this method
  - setComment
```
public void setComment(java.lang.String comment)
```
    Sets the comment describing this JMethod. The comment will be printed when this JMethod is printed.
    
    Parameters:
    
    comment - the comment for this member
    
    See Also:
    
    getJDocComment()
  - setModifiers
```
public void setModifiers(JModifiers modifiers)
```
    Sets the JModifiers for this JMethod. This JMethod will use only a copy of the JModifiers.
    Note: The JModifiers will be set in the containing JMethodSignature. If the JMethodSignature is used by other methods, keep in mind that it will be changed.
    
    Parameters:
    
    modifiers - the JModifiers to set.
  - setSourceCode
```
public void setSourceCode(java.lang.String source)
```
    Sets the given string as the source code (method body) for this JMethod.
    
    Parameters:
    
    source - the String that represents the method body
  - setSourceCode
```
public void setSourceCode(JSourceCode source)
```
    Sets the given JSourceCode as the source code (method body) for this JMethod.
    
    Parameters:
    
    source - the JSourceCode that represents the method body
  - print
```
public void print(JSourceWriter jsw)
```
    Prints this JMethod to the given JSourceWriter.
    
    Parameters:
    
    jsw - the JSourceWriter to print to
  - toString
```
public java.lang.String toString()
```
    Returns the String representation of this JMethod, which is the method prototype.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the String representation of this JMethod, which is simply the method prototype
  - getAnnotation
```
public JAnnotation getAnnotation(JAnnotationType annotationType)
```
    Description copied from interface: JAnnotatedElement
    
    Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
    
    Specified by:
    
    getAnnotation in interface JAnnotatedElement
    
    Parameters:
    
    annotationType - Annotation type to retrieve
    
    Returns:
    
    A JAnnotation for the given JAnnotationType
    
    See Also:
    
    #getAnnotation(org.exolab.javasource.JAnnotationType) {@inheritDoc}
  - getAnnotations
```
public JAnnotation[] getAnnotations()
```
    Description copied from interface: JAnnotatedElement
    
    Returns a list of JAnnotation's already set on this source element.
    
    Specified by:
    
    getAnnotations in interface JAnnotatedElement
    
    Returns:
    
    A list of all JAnnotations associated with this source element.
    
    See Also:
    
    {@inheritDoc}
  - isAnnotationPresent
```
public boolean isAnnotationPresent(JAnnotationType annotationType)
```
    Description copied from interface: JAnnotatedElement
    
    Returns true if a JAnnotation exists for the given JAnnotationType.
    
    Specified by:
    
    isAnnotationPresent in interface JAnnotatedElement
    
    Parameters:
    
    annotationType - Annotation type to check for presence or absense
    
    Returns:
    
    True if a JAnnotation has been added for the given JAnnotationType.
    
    See Also:
    
    #isAnnotationPresent(org.exolab.javasource.JAnnotationType) {@inheritDoc}
  - addAnnotation
```
public void addAnnotation(JAnnotation annotation)
```
    Description copied from interface: JAnnotatedElement
    
    Adds a JAnnotation to this source element. An IllegalArgumentException is thrown if one already exists for the associated JAnnotationType.
    
    Specified by:
    
    addAnnotation in interface JAnnotatedElement
    
    Parameters:
    
    annotation - a JAnnotation to add to this source element.
    
    See Also:
    
    #addAnnotation(org.exolab.javasource.JAnnotation) {@inheritDoc}
  - removeAnnotation
```
public JAnnotation removeAnnotation(JAnnotationType annotationType)
```
    Description copied from interface: JAnnotatedElement
    
    Removes the JAnnotation from this source element for the given JAnnotationType. An IllegalArgumentException is thrown if the provided JAnnotation isn't present.
    
    Specified by:
    
    removeAnnotation in interface JAnnotatedElement
    
    Parameters:
    
    annotationType - Annotation type to remove
    
    Returns:
    
    The JAnnotation that was associated with this source element
    
    See Also:
    
    #removeAnnotation(org.exolab.javasource.JAnnotationType) {@inheritDoc}
  - hasAnnotations
```
public boolean hasAnnotations()
```
    Description copied from interface: JAnnotatedElement
    
    Returns true if this source element has any annotations.
    
    Specified by:
    
    hasAnnotations in interface JAnnotatedElement
    
    Returns:
    
    Returns true if this source element has any annotations.
    
    See Also:
    
    {@inheritDoc}
  - addDeclaringClass
```
protected void addDeclaringClass(JClass jClass)
```
    Adds the given JClass to the set of classes that contain this method.
    
    Parameters:
    
    jClass - the JClass to add as one of the JClasses that contain this method
  - removeDeclaringClass
```
protected void removeDeclaringClass(JClass jClass)
```
    Removes the given JClass from the set of classes that contain this method.
    
    Parameters:
    
    jClass - the JClass to remove as one of the JClasses that contain this method
  - getParameterClassNames
```
protected java.lang.String[] getParameterClassNames()
```
    Return the list of class names representing the parameters.
    
    Returns:
    
    the list of class names representing the parameters
    
    See Also:
    
    JMethodSignature.getParameterClassNames()

Class JMethod

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JMethod

JMethod

Method Detail

addException

addParameter

getJDocComment

getExceptions

getModifiers

getName

getParameter

getParameters

getReturnType

getSignature

getSourceCode

setName

setComment

setModifiers

setSourceCode

setSourceCode

print

toString

getAnnotation

getAnnotations

isAnnotationPresent

addAnnotation

removeAnnotation

hasAnnotations

addDeclaringClass

removeDeclaringClass

getParameterClassNames