Java Doc for JDocDescriptor.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.JDocDescriptor JDocDescriptor final public class JDocDescriptor (Code) A descriptor for a JavaDoc comment. author:    Keith Visco version:    $Revision: 6669 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $ Field Summary final public static  short AUTHOR      The author descriptor. final public static  String DEFAULT_VERSION      The default version string, broken into parts so CVS does not expand it. final public static  short EXCEPTION      The exception descriptor (exception). final public static  short PARAM      The param descriptor (param). final public static  short REFERENCE      The reference descriptor (see). final public static  short RETURN      The return descriptor (return). final public static  short VERSION      The version descriptor (version). Method Summary protected  short compareTo(JDocDescriptor jdd)      Compares the type of this JDocDescriptor with the given descriptor. Enables sorting of descriptors. Parameters:   jdd - A JDocDescriptor to be compared to this one. public static  JDocDescriptor createAuthorDesc()      Creates a new, empty @author JavaDoc descriptor. public static  JDocDescriptor createAuthorDesc(String name)      Creates a new @author JavaDoc descriptor with the provided author name string. Parameters:   name - The author name string. public static  JDocDescriptor createExceptionDesc()      Creates a new, empty @exception JavaDoc descriptor. public static  JDocDescriptor createExceptionDesc(String name, String desc)      Creates a new @exception JavaDoc descriptor with a given exception name and a description of when the exception is thrown. Parameters:   name - The exception name. Parameters:   desc - The description of when the exception is thrown. public static  JDocDescriptor createParamDesc()      Creates a new, empty @param JavaDoc descriptor. public static  JDocDescriptor createParamDesc(String name, String desc)      Creates a new @param JavaDoc descriptor with the given parameter name and description. Parameters:   name - The param name. Parameters:   desc - The param description string. public static  JDocDescriptor createReferenceDesc()      Creates a new, empty @reference JavaDoc descriptor. public static  JDocDescriptor createReferenceDesc(String name)      Creates a new @reference JavaDoc descriptor with the provided reference string. Parameters:   name - The reference name string. public static  JDocDescriptor createReturnDesc()      Creates a new, empty @return JavaDoc descriptor. public static  JDocDescriptor createReturnDesc(String desc)      Creates a new @return JavaDoc descriptor with the provided description of what is returned. Parameters:   desc - The return description. public static  JDocDescriptor createVersionDesc()      Creates a new, empty @version JavaDoc descriptor. public static  JDocDescriptor createVersionDesc(String version)      Creates a new @version JavaDoc descriptor with the provided version string. Parameters:   version - The version string. public  String getDescription()      Returns the description String. public  String getName()      Returns the name of the object being described. public  short getType()      Returns the type of this JDocDescriptor. public  void setDescription(String desc)      Sets the description String for this descriptor. public  void setName(String name)      Sets the name value of the JavaDoc field. public  String toString()      Field Detail AUTHOR final public static short AUTHOR(Code) The author descriptor. DEFAULT_VERSION final public static String DEFAULT_VERSION(Code) The default version string, broken into parts so CVS does not expand it. EXCEPTION final public static short EXCEPTION(Code) The exception descriptor (exception). PARAM final public static short PARAM(Code) The param descriptor (param). REFERENCE final public static short REFERENCE(Code) The reference descriptor (see). RETURN final public static short RETURN(Code) The return descriptor (return). VERSION final public static short VERSION(Code) The version descriptor (version). Method Detail compareTo protected short compareTo(JDocDescriptor jdd)(Code) Compares the type of this JDocDescriptor with the given descriptor. Enables sorting of descriptors. Parameters:   jdd - A JDocDescriptor to be compared to this one. 0 if the two descriptor types are equal, 1 if the type of thisdescriptor is greater than the given descriptor, or -1 if thetype of this descriptor is less than the given descriptor. createAuthorDesc public static JDocDescriptor createAuthorDesc()(Code) Creates a new, empty @author JavaDoc descriptor. The new JDocDescriptor. createAuthorDesc public static JDocDescriptor createAuthorDesc(String name)(Code) Creates a new @author JavaDoc descriptor with the provided author name string. Parameters:   name - The author name string. The new JDocDescriptor. createExceptionDesc public static JDocDescriptor createExceptionDesc()(Code) Creates a new, empty @exception JavaDoc descriptor. The new JDocDescriptor. createExceptionDesc public static JDocDescriptor createExceptionDesc(String name, String desc)(Code) Creates a new @exception JavaDoc descriptor with a given exception name and a description of when the exception is thrown. Parameters:   name - The exception name. Parameters:   desc - The description of when the exception is thrown. The new JDocDescriptor. createParamDesc public static JDocDescriptor createParamDesc()(Code) Creates a new, empty @param JavaDoc descriptor. The new JDocDescriptor. createParamDesc public static JDocDescriptor createParamDesc(String name, String desc)(Code) Creates a new @param JavaDoc descriptor with the given parameter name and description. Parameters:   name - The param name. Parameters:   desc - The param description string. The new JDocDescriptor. createReferenceDesc public static JDocDescriptor createReferenceDesc()(Code) Creates a new, empty @reference JavaDoc descriptor. The new JDocDescriptor. createReferenceDesc public static JDocDescriptor createReferenceDesc(String name)(Code) Creates a new @reference JavaDoc descriptor with the provided reference string. Parameters:   name - The reference name string. The new JDocDescriptor. createReturnDesc public static JDocDescriptor createReturnDesc()(Code) Creates a new, empty @return JavaDoc descriptor. The new JDocDescriptor. createReturnDesc public static JDocDescriptor createReturnDesc(String desc)(Code) Creates a new @return JavaDoc descriptor with the provided description of what is returned. Parameters:   desc - The return description. The new JDocDescriptor. createVersionDesc public static JDocDescriptor createVersionDesc()(Code) Creates a new, empty @version JavaDoc descriptor. The new JDocDescriptor. createVersionDesc public static JDocDescriptor createVersionDesc(String version)(Code) Creates a new @version JavaDoc descriptor with the provided version string. Parameters:   version - The version string. The new JDocDescriptor. getDescription public String getDescription()(Code) Returns the description String. The description string. getName public String getName()(Code) Returns the name of the object being described. This is valid for the following fields: author exception param see The name of the object being described. getType public short getType()(Code) Returns the type of this JDocDescriptor. The type of this JDocDescriptor. setDescription public void setDescription(String desc)(Code) Sets the description String for this descriptor. Parameters:   desc - The description of the object being described. setName public void setName(String name)(Code) Sets the name value of the JavaDoc field. This is only valid for the following fields: author exception param see Parameters:   name - The name value of the JavaDoc field. 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)