org.exolab.javasource

Class JDocDescriptor


public final class JDocDescriptor
extends java.lang.Object

A descriptor for a JavaDoc comment.
Version:
$Revision: 6324 $ $Date: 2003-03-03 00:05:44 -0700 (Mon, 03 Mar 2003) $
Author:
Keith Visco

Field Summary

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).

Method Summary

protected short
compareTo(JDocDescriptor jdd)
Compares the type of this JDocDescriptor with the given descriptor.
static JDocDescriptor
createAuthorDesc()
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
createExceptionDesc()
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
createParamDesc()
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
createReferenceDesc()
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
createReturnDesc()
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
createVersionDesc()
Creates a new, empty @version JavaDoc descriptor.
static JDocDescriptor
createVersionDesc(String version)
Creates a new @version JavaDoc descriptor with the provided version string.
String
getDescription()
Returns the description String.
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
setName(String name)
Sets the name value of the JavaDoc field.
String
toString()
Returns the String representation of this JDocDescriptor.

Field Details

AUTHOR

public static final short AUTHOR
The author descriptor.
Field Value:
3

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).
Field Value:
1

PARAM

public static final short PARAM
The param descriptor (param).
Field Value:
0

REFERENCE

public static final short REFERENCE
The reference descriptor (see).
Field Value:
5

RETURN

public static final short RETURN
The return descriptor (return).
Field Value:
2

VERSION

public static final short VERSION
the version descriptor (version).
Field Value:
4

Method Details

compareTo

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
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

public static JDocDescriptor createAuthorDesc()
Creates a new, empty @author JavaDoc descriptor.
Returns:
the new JDocDescriptor.

createAuthorDesc

public static JDocDescriptor createAuthorDesc(String name)
Creates a new @author JavaDoc descriptor with the provided author name string.
Parameters:
name - the author name string
Returns:
the new JDocDescriptor

createExceptionDesc

public static JDocDescriptor createExceptionDesc()
Creates a new, empty @exception JavaDoc descriptor.
Returns:
the new JDocDescriptor.

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.
Parameters:
name - the exception name
desc - the description of when the exception is thrown
Returns:
the new JDocDescriptor.

createParamDesc

public static JDocDescriptor createParamDesc()
Creates a new, empty @param JavaDoc descriptor.
Returns:
the new JDocDescriptor.

createParamDesc

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
desc - the param description string
Returns:
the new JDocDescriptor.

createReferenceDesc

public static JDocDescriptor createReferenceDesc()
Creates a new, empty @reference JavaDoc descriptor.
Returns:
the new JDocDescriptor.

createReferenceDesc

public static JDocDescriptor createReferenceDesc(String name)
Creates a new @reference JavaDoc descriptor with the provided reference string.
Parameters:
name - the reference name string
Returns:
the new JDocDescriptor.

createReturnDesc

public static JDocDescriptor createReturnDesc()
Creates a new, empty @return JavaDoc descriptor.
Returns:
the new JDocDescriptor.

createReturnDesc

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
Returns:
the new JDocDescriptor.

createVersionDesc

public static JDocDescriptor createVersionDesc()
Creates a new, empty @version JavaDoc descriptor.
Returns:
the new JDocDescriptor.

createVersionDesc

public static JDocDescriptor createVersionDesc(String version)
Creates a new @version JavaDoc descriptor with the provided version string.
Parameters:
version - the version string
Returns:
the new JDocDescriptor.

getDescription

public String getDescription()
Returns the description String.
Returns:
the description string.

getName

public 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. This

getType

public short getType()
Returns the type of this JDocDescriptor.
Returns:
the type of this JDocDescriptor.

setDescription

public void setDescription(String desc)
Sets the description String for this descriptor.
Parameters:
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
Parameters:
name - the name value of the JavaDoc field

toString

public String toString()
Returns the String representation of this JDocDescriptor.
Returns:
the String representation of this JDocDescriptor.

Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com