Java Doc for JMethod.java in  » Database-ORM » castor » org » exolab » javasource » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database ORM » castor » org.exolab.javasource 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

JMethod
final public class JMethod implements JMember,JAnnotatedElement(Code)
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.
author:
   Keith Visco
version:
   $Revision: 6676 $ $Date: 2004-12-03 11:57:33 -0700 (Fri, 03 Dec 2004) $



Constructor Summary
public  JMethod(String name)
     Creates a new JMethod with the given name and "void" return type.
Parameters:
  name - The method name.
public  JMethod(String name, JType returnType, String returnDoc)
     Creates a new JMethod with the given name and returnType.

Method Summary
public  voidaddAnnotation(JAnnotation annotation)
    
public  voidaddException(JClass exp, String description)
     Adds the given Exception to this JMethod's throws clause.
public  voidaddParameter(JParameter parameter)
     Adds the given parameter to this JMethod's list of parameters.
public  JAnnotationgetAnnotation(JAnnotationType annotationType)
    
public  JAnnotation[]getAnnotations()
    
public  JClass[]getExceptions()
     Returns the exceptions that this JMethod throws.
public  JDocCommentgetJDocComment()
     Returns the JavaDoc comment describing this JMethod.
public  JModifiersgetModifiers()
     Returns the modifiers for this JMethod.
public  StringgetName()
     Returns the name of this JMethod.
public  JParametergetParameter(int index)
     Returns the JParameter at the given index.
Parameters:
  index - The index of the JParameter to return.
public  JParameter[]getParameters()
     Returns the set of JParameters for this JMethod.
public  JTypegetReturnType()
     Returns the JType that represents the return type of the JMethod.
public  JMethodSignaturegetSignature()
     Returns the JMethodSignature for this JMethod.
public  JSourceCodegetSourceCode()
     Returns the JSourceCode for the method body.
public  booleanhasAnnotations()
    
public  booleanisAnnotationPresent(JAnnotationType annotationType)
    
public  voidprint(JSourceWriter jsw)
     Prints this JMethod to the given JSourceWriter.
public  JAnnotationremoveAnnotation(JAnnotationType annotationType)
    
public  voidsetComment(String comment)
     Sets the comment describing this JMethod.
public  voidsetModifiers(JModifiers modifiers)
     Sets the JModifiers for this JMethod.
public  voidsetName(String name)
     Sets the name of this JMethod.
public  voidsetSourceCode(String source)
     Sets the given string as the source code (method body) for this JMethod.
public  voidsetSourceCode(JSourceCode source)
     Sets the given JSourceCode as the source code (method body) for this JMethod.
public  StringtoString()
    


Constructor Detail
JMethod
public JMethod(String name)(Code)
Creates a new JMethod with the given name and "void" return type.
Parameters:
  name - The method name. Must not be null.



JMethod
public JMethod(String name, JType returnType, String returnDoc)(Code)
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.JMethod(String) instead of this constructor.
Parameters:
  name - The method name. Must not be null.
Parameters:
  returnType - The return type of the method. Must not be null.
Parameters:
  returnDoc - Javadoc comment for the @return annotation. Ifnull, a default (and mostly useless) javadoc comment will begenerated.




Method Detail
addAnnotation
public void addAnnotation(JAnnotation annotation)(Code)



addException
public void addException(JClass exp, String description)(Code)
Adds the given Exception to this JMethod's throws clause.
Parameters:
  exp - The JClass representing the Exception.
Parameters:
  description - JavaDoc comment explaining when this exception is thrown.



addParameter
public void addParameter(JParameter parameter)(Code)
Adds the given parameter to this JMethod's list of parameters.
Parameters:
  parameter - The parameter to add to the this JMethod's list ofparameters.



getAnnotation
public JAnnotation getAnnotation(JAnnotationType annotationType)(Code)



getAnnotations
public JAnnotation[] getAnnotations()(Code)



getExceptions
public JClass[] getExceptions()(Code)
Returns the exceptions that this JMethod throws. The exceptions that this JMethod throws.



getJDocComment
public JDocComment getJDocComment()(Code)
Returns the JavaDoc comment describing this JMethod. The JavaDoc comment describing this JMethod.



getModifiers
public JModifiers getModifiers()(Code)
Returns the modifiers for this JMethod. The modifiers for this JMethod.



getName
public String getName()(Code)
Returns the name of this JMethod. The name of this JMethod.



getParameter
public JParameter getParameter(int index)(Code)
Returns the JParameter at the given index.
Parameters:
  index - The index of the JParameter to return. The JParameter at the given index.



getParameters
public JParameter[] getParameters()(Code)
Returns the set of JParameters for this JMethod.
Note: the array is a copy, the parameters in the array are the actual references. The set of JParameters for this JMethod.



getReturnType
public JType getReturnType()(Code)
Returns the JType that represents the return type of the JMethod. The JType that represents the return type of the JMethod.



getSignature
public JMethodSignature getSignature()(Code)
Returns the JMethodSignature for this JMethod. The JMethodSignature for this JMethod.



getSourceCode
public JSourceCode getSourceCode()(Code)
Returns the JSourceCode for the method body. The JSourceCode for the method body.



hasAnnotations
public boolean hasAnnotations()(Code)



isAnnotationPresent
public boolean isAnnotationPresent(JAnnotationType annotationType)(Code)



print
public void print(JSourceWriter jsw)(Code)
Prints this JMethod to the given JSourceWriter.
Parameters:
  jsw - The JSourceWriter to print to.



removeAnnotation
public JAnnotation removeAnnotation(JAnnotationType annotationType)(Code)



setComment
public void setComment(String comment)(Code)
Sets the comment describing this JMethod. The comment will be printed when this JMethod is printed.
Parameters:
  comment - The comment for this member.



setModifiers
public void setModifiers(JModifiers modifiers)(Code)
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.



setName
public void setName(String name)(Code)
Sets the name of this JMethod.
Parameters:
  name - The name of this method.



setSourceCode
public void setSourceCode(String source)(Code)
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)(Code)
Sets the given JSourceCode as the source code (method body) for this JMethod.
Parameters:
  source - The JSourceCode that represents the method body.



toString
public String toString()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.