org.exolab.javasource
Class JDocDescriptor
java.lang.Object
org.exolab.javasource.JDocDescriptor
public final class JDocDescriptor
extends java.lang.Object
A descriptor for a JavaDoc comment.
$Revision: 6669 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $static short | AUTHOR - The author descriptor.
|
static String | DEFAULT_VERSION - The default version string, broken into parts so CVS does not expand it.
|
static short | EXCEPTION - The exception descriptor (exception).
|
static short | PARAM - The param descriptor (param).
|
static short | REFERENCE - The reference descriptor (see).
|
static short | RETURN - The return descriptor (return).
|
static short | VERSION - The version descriptor (version).
|
AUTHOR
public static final short AUTHOR
The author descriptor.
DEFAULT_VERSION
public static final String DEFAULT_VERSION
The default version string, broken into parts so CVS does not expand it.
EXCEPTION
public static final short EXCEPTION
The exception descriptor (exception).
PARAM
public static final short PARAM
The param descriptor (param).
REFERENCE
public static final short REFERENCE
The reference descriptor (see).
RETURN
public static final short RETURN
The return descriptor (return).
VERSION
public static final short VERSION
The version descriptor (version).
compareTo
protected short compareTo(JDocDescriptor jdd)
Compares the type of this JDocDescriptor with the given descriptor.
Enables sorting of descriptors.
jdd
- A JDocDescriptor to be compared to this one.
- 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
public static JDocDescriptor createAuthorDesc()
Creates a new, empty @author JavaDoc descriptor.
createAuthorDesc
public static JDocDescriptor createAuthorDesc(String name)
Creates a new @author JavaDoc descriptor with the provided author name
string.
name
- The author name string.
createExceptionDesc
public static JDocDescriptor createExceptionDesc()
Creates a new, empty @exception JavaDoc descriptor.
createExceptionDesc
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.
name
- The exception name.desc
- The description of when the exception is thrown.
createParamDesc
public static JDocDescriptor createParamDesc()
Creates a new, empty @param JavaDoc descriptor.
createParamDesc
public static JDocDescriptor createParamDesc(String name,
String desc)
Creates a new @param JavaDoc descriptor with the given parameter
name and description.
name
- The param name.desc
- The param description string.
createReferenceDesc
public static JDocDescriptor createReferenceDesc()
Creates a new, empty @reference JavaDoc descriptor.
createReferenceDesc
public static JDocDescriptor createReferenceDesc(String name)
Creates a new @reference JavaDoc descriptor with the provided
reference string.
name
- The reference name string.
createReturnDesc
public static JDocDescriptor createReturnDesc()
Creates a new, empty @return JavaDoc descriptor.
createReturnDesc
public static JDocDescriptor createReturnDesc(String desc)
Creates a new @return JavaDoc descriptor with the provided
description of what is returned.
desc
- The return description.
createVersionDesc
public static JDocDescriptor createVersionDesc()
Creates a new, empty @version JavaDoc descriptor.
createVersionDesc
public static JDocDescriptor createVersionDesc(String version)
Creates a new @version JavaDoc descriptor with the provided version
string.
version
- The version string.
getDescription
public String getDescription()
Returns the description String.
getName
public String getName()
Returns the name of the object being described. This is valid for the
following fields:
- The name of the object being described.
getType
public short getType()
Returns the type of this JDocDescriptor.
- The type of this JDocDescriptor.
setDescription
public void setDescription(String desc)
Sets the description String for this descriptor.
desc
- The description of the object being described.
setName
public void setName(String name)
Sets the name value of the JavaDoc field. This is only valid for the
following fields:
name
- The name value of the JavaDoc field.
toString
public String toString()
Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com