Package org.exolab.javasource
Class JDocDescriptor
java.lang.Object
org.exolab.javasource.JDocDescriptor
A descriptor for a JavaDoc comment.
- Version:
- $Revision: 7918 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
- Author:
- Keith Visco
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
The author descriptor.static final String
The default version string, broken into parts so CVS does not expand it.static final short
The exception descriptor (exception).static final short
The param descriptor (param).static final short
The reference descriptor (see).static final short
The return descriptor (return).static final short
The version descriptor (version). -
Method Summary
Modifier and TypeMethodDescriptionprotected short
compareTo
(JDocDescriptor jdd) Compares the type of this JDocDescriptor with the given descriptor.static JDocDescriptor
Creates a new, empty @author JavaDoc descriptor.static JDocDescriptor
createAuthorDesc
(String name) Creates a new @author JavaDoc descriptor with the provided author name string.static JDocDescriptor
Creates a new, empty @exception JavaDoc descriptor.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.static JDocDescriptor
Creates a new, empty @param JavaDoc descriptor.static JDocDescriptor
createParamDesc
(String name, String desc) Creates a new @param JavaDoc descriptor with the given parameter name and description.static JDocDescriptor
Creates a new, empty @reference JavaDoc descriptor.static JDocDescriptor
createReferenceDesc
(String name) Creates a new @reference JavaDoc descriptor with the provided reference string.static JDocDescriptor
Creates a new, empty @return JavaDoc descriptor.static JDocDescriptor
createReturnDesc
(String desc) Creates a new @return JavaDoc descriptor with the provided description of what is returned.static JDocDescriptor
Creates a new, empty @version JavaDoc descriptor.static JDocDescriptor
createVersionDesc
(String version) Creates a new @version JavaDoc descriptor with the provided version string.Returns the description String.getName()
Returns the name of the object being described.short
getType()
Returns the type of this JDocDescriptor.void
setDescription
(String desc) Sets the description String for this descriptor.void
Sets the name value of the JavaDoc field.toString()
-
Field Details
-
DEFAULT_VERSION
The default version string, broken into parts so CVS does not expand it.- See Also:
-
PARAM
public static final short PARAMThe param descriptor (param).- See Also:
-
EXCEPTION
public static final short EXCEPTIONThe exception descriptor (exception).- See Also:
-
RETURN
public static final short RETURNThe return descriptor (return).- See Also:
-
AUTHOR
public static final short AUTHORThe author descriptor.- See Also:
-
VERSION
public static final short VERSIONThe version descriptor (version).- See Also:
-
REFERENCE
public static final short REFERENCEThe reference descriptor (see).- See Also:
-
-
Method Details
-
compareTo
Compares the type of this JDocDescriptor with the given descriptor. Enables sorting of descriptors.- Parameters:
jdd
- A JDocDescriptor to be compared to this one.- Returns:
- 0 if the two descriptor types are equal, 1 if the type of this descriptor is greater than the given descriptor, or -1 if the type of this descriptor is less than the given descriptor.
-
createAuthorDesc
Creates a new, empty @author JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createAuthorDesc
Creates a new @author JavaDoc descriptor with the provided author name string.- Parameters:
name
- The author name string.- Returns:
- The new JDocDescriptor.
-
createExceptionDesc
Creates a new, empty @exception JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createExceptionDesc
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.desc
- The description of when the exception is thrown.- Returns:
- The new JDocDescriptor.
-
createParamDesc
Creates a new, empty @param JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createParamDesc
Creates a new @param JavaDoc descriptor with the given parameter name and description.- Parameters:
name
- The param name.desc
- The param description string.- Returns:
- The new JDocDescriptor.
-
createReferenceDesc
Creates a new, empty @reference JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createReferenceDesc
Creates a new @reference JavaDoc descriptor with the provided reference string.- Parameters:
name
- The reference name string.- Returns:
- The new JDocDescriptor.
-
createReturnDesc
Creates a new, empty @return JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createReturnDesc
Creates a new @return JavaDoc descriptor with the provided description of what is returned.- Parameters:
desc
- The return description.- Returns:
- The new JDocDescriptor.
-
createVersionDesc
Creates a new, empty @version JavaDoc descriptor.- Returns:
- The new JDocDescriptor.
-
createVersionDesc
Creates a new @version JavaDoc descriptor with the provided version string.- Parameters:
version
- The version string.- Returns:
- The new JDocDescriptor.
-
getDescription
Returns the description String.- Returns:
- The description string.
-
getName
Returns the name of the object being described. This is valid for the following fields:- author
- exception
- param
- see
- Returns:
- The name of the object being described.
-
getType
public short getType()Returns the type of this JDocDescriptor.- Returns:
- The type of this JDocDescriptor.
-
setDescription
Sets the description String for this descriptor.- Parameters:
desc
- The description of the object being described.
-
setName
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
-