Package org.codehaus.modello.plugin.java.javasource

Class JDocDescriptor

java.lang.Object

org.codehaus.modello.plugin.java.javasource.JDocDescriptor

public class JDocDescriptor
extends Object

A descriptor for a JavaDoc comment

Version:

$Revision$ $Date$

Author:

Keith Visco

Field Summary

Fields

Modifier and Type	Field	Description
static final short	AUTHOR	The author descriptor
static final String	DEFAULT_VERSION	The default version string
static final short	EXCEPTION	The exception descriptor (exception)
static final short	PARAM	The param descriptor (param)
static final short	REFERENCE	The reference descriptor (see)
static final short	RETURN	The return descriptor (return)
static final short	VERSION	the version descriptor (version)

Method Summary

Modifier and Type	Method	Description
protected short	compareTo(JDocDescriptor jdd)	Compares the type of this JDocDescriptor with the given descriptor.
static JDocDescriptor	createAuthorDesc()	Creates a new author descriptor
static JDocDescriptor	createAuthorDesc(String name)	Creates a new author descriptor
static JDocDescriptor	createExceptionDesc()	Creates a new exception descriptor
static JDocDescriptor	createExceptionDesc(String name, String desc)	Creates a new exception descriptor
static JDocDescriptor	createParamDesc()	Creates a new param descriptor
static JDocDescriptor	createParamDesc(String name, String desc)	Creates a new param descriptor
static JDocDescriptor	createReferenceDesc()	Creates a new reference descriptor
static JDocDescriptor	createReferenceDesc(String name)	Creates a new reference descriptor
static JDocDescriptor	createReturnDesc()	Creates a new return descriptor
static JDocDescriptor	createReturnDesc(String desc)	Creates a new return descriptor
static JDocDescriptor	createVersionDesc()	Creates a new version descriptor
static JDocDescriptor	createVersionDesc(String version)	Creates a new version descriptor
String	getDescription()	Returns the description String for this descriptor
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_VERSION

public static final String DEFAULT_VERSION

The default version string

See Also:

• Constant Field Values

PARAM

public static final short PARAM

The param descriptor (param)

See Also:

• Constant Field Values

EXCEPTION

public static final short EXCEPTION

The exception descriptor (exception)

See Also:

• Constant Field Values

RETURN

public static final short RETURN

The return descriptor (return)

See Also:

• Constant Field Values

AUTHOR

public static final short AUTHOR

The author descriptor

See Also:

• Constant Field Values

VERSION

public static final short VERSION

the version descriptor (version)

See Also:

• Constant Field Values

REFERENCE

public static final short REFERENCE

The reference descriptor (see)

See Also:

• Constant Field Values

Method Details

compareTo

protected short compareTo(JDocDescriptor jdd)

Compares the type of this JDocDescriptor with the given descriptor. Enables sorting of descriptors.

Parameters:

jdd - the javadoc descriptor

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

Returns:

the new JDocDescriptor

createAuthorDesc

public static JDocDescriptor createAuthorDesc(String name)

Creates a new author descriptor

Parameters:

name - the author name string

Returns:

the new JDocDescriptor

createExceptionDesc

public static JDocDescriptor createExceptionDesc()

Creates a new exception descriptor

Returns:

the new JDocDescriptor

createExceptionDesc

public static JDocDescriptor createExceptionDesc(String name,
 String desc)

Creates a new exception descriptor

Parameters:

name - the exception name

desc - the description of when the exception is called

Returns:

the new JDocDescriptor

createParamDesc

public static JDocDescriptor createParamDesc()

Creates a new param descriptor

Returns:

the new JDocDescriptor

createParamDesc

public static JDocDescriptor createParamDesc(String name,
 String desc)

Creates a new param descriptor

Parameters:

name - the param name

desc - the param description string

Returns:

the new JDocDescriptor

createReferenceDesc

public static JDocDescriptor createReferenceDesc()

Creates a new reference descriptor

Returns:

the new JDocDescriptor

createReferenceDesc

public static JDocDescriptor createReferenceDesc(String name)

Creates a new reference descriptor

Parameters:

name - the reference name string

Returns:

the new JDocDescriptor

createReturnDesc

public static JDocDescriptor createReturnDesc()

Creates a new return descriptor

Returns:

the new JDocDescriptor

createReturnDesc

public static JDocDescriptor createReturnDesc(String desc)

Creates a new return descriptor

Parameters:

desc - the return description

Returns:

the new JDocDescriptor

createVersionDesc

public static JDocDescriptor createVersionDesc()

Creates a new version descriptor

Returns:

the new JDocDescriptor

createVersionDesc

public static JDocDescriptor createVersionDesc(String version)

Creates a new version descriptor

Parameters:

version - the version string

Returns:

the new JDocDescriptor

getDescription

public String getDescription()

Returns the description String for this descriptor

Returns:

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

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

Overrides:

toString in class Object

Returns:

the String representation of this JDocDescriptor