org.exolab.javasource
Class JDocDescriptor
java.lang.Object
org.exolab.javasource.JDocDescriptor
public class JDocDescriptor
extends java.lang.Object
A descriptor for a JavaDoc comment
Version:
- Keith Visco
static short | AUTHOR - The author descriptor
|
static String | DEFAULT_VERSION - The default version string
|
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
- 3
DEFAULT_VERSION
public static final String DEFAULT_VERSION
The default version string
EXCEPTION
public static final short EXCEPTION
The exception descriptor (exception)
- 1
PARAM
public static final short PARAM
The param descriptor (param)
- 0
REFERENCE
public static final short REFERENCE
The reference descriptor (see)
- 5
RETURN
public static final short RETURN
The return descriptor (return)
- 2
VERSION
public static final short VERSION
the version descriptor (version)
- 4
compareTo
protected short compareTo(JDocDescriptor jdd)
Compares the type of this JDocDescriptor with the given descriptor.
Enables sorting of descriptors.
- 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 author descriptor
- the new JDocDescriptor
createAuthorDesc
public static JDocDescriptor createAuthorDesc(String name)
Creates a new author descriptor
name
- the author name string
- the new JDocDescriptor
createExceptionDesc
public static JDocDescriptor createExceptionDesc()
Creates a new exception descriptor
- the new JDocDescriptor
createExceptionDesc
public static JDocDescriptor createExceptionDesc(String name,
String desc)
Creates a new exception descriptor
name
- the exception namedesc
- the description of when the exception is called
- the new JDocDescriptor
createParamDesc
public static JDocDescriptor createParamDesc()
Creates a new param descriptor
- the new JDocDescriptor
createParamDesc
public static JDocDescriptor createParamDesc(String name,
String desc)
Creates a new param descriptor
name
- the param namedesc
- the param description string
- the new JDocDescriptor
createReferenceDesc
public static JDocDescriptor createReferenceDesc()
Creates a new reference descriptor
- the new JDocDescriptor
createReferenceDesc
public static JDocDescriptor createReferenceDesc(String name)
Creates a new reference descriptor
name
- the reference name string
- the new JDocDescriptor
createReturnDesc
public static JDocDescriptor createReturnDesc()
Creates a new return descriptor
- the new JDocDescriptor
createReturnDesc
public static JDocDescriptor createReturnDesc(String desc)
Creates a new return descriptor
desc
- the return description
- the new JDocDescriptor
createVersionDesc
public static JDocDescriptor createVersionDesc()
Creates a new version descriptor
- the new JDocDescriptor
createVersionDesc
public static JDocDescriptor createVersionDesc(String version)
Creates a new version descriptor
version
- the version string
- the new JDocDescriptor
getDescription
public String getDescription()
Returns the description String for this descriptor
- the description string for this descriptor
getName
public String getName()
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. This
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:
- author
- exception
- param
- see
name
- the name value of the JavaDoc field
toString
public String toString()
Returns the String representation of this JDocDescriptor
- the String representation of this JDocDescriptor
Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com