public class JDocDescriptor
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static short |
AUTHOR
The author descriptor
|
static java.lang.String |
DEFAULT_VERSION
The default version string
|
private java.lang.String |
description |
static short |
EXCEPTION
The exception descriptor (exception)
|
private java.lang.String |
name |
static short |
PARAM
The param descriptor (param)
|
static short |
REFERENCE
The reference descriptor (see)
|
static short |
RETURN
The return descriptor (return)
|
private short |
type |
static short |
VERSION
the version descriptor (version)
|
Modifier | Constructor and Description |
---|---|
private |
JDocDescriptor(short type)
Creates a new JDocDescriptor
|
private |
JDocDescriptor(short type,
java.lang.String name,
java.lang.String desc)
Creates a new JDocDescriptor
|
Modifier and Type | Method and 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(java.lang.String name)
Creates a new author descriptor
|
static JDocDescriptor |
createExceptionDesc()
Creates a new exception descriptor
|
static JDocDescriptor |
createExceptionDesc(java.lang.String name,
java.lang.String desc)
Creates a new exception descriptor
|
static JDocDescriptor |
createParamDesc()
Creates a new param descriptor
|
static JDocDescriptor |
createParamDesc(java.lang.String name,
java.lang.String desc)
Creates a new param descriptor
|
static JDocDescriptor |
createReferenceDesc()
Creates a new reference descriptor
|
static JDocDescriptor |
createReferenceDesc(java.lang.String name)
Creates a new reference descriptor
|
static JDocDescriptor |
createReturnDesc()
Creates a new return descriptor
|
static JDocDescriptor |
createReturnDesc(java.lang.String desc)
Creates a new return descriptor
|
static JDocDescriptor |
createVersionDesc()
Creates a new version descriptor
|
static JDocDescriptor |
createVersionDesc(java.lang.String version)
Creates a new version descriptor
|
java.lang.String |
getDescription()
Returns the description String for this descriptor
|
java.lang.String |
getName()
Returns the name of the object being described.
|
short |
getType()
Returns the type of this JDocDescriptor
|
void |
setDescription(java.lang.String desc)
Sets the description String for this descriptor
|
void |
setName(java.lang.String name)
Sets the name value of the JavaDoc field.
|
java.lang.String |
toString()
Returns the String representation of this JDocDescriptor
|
public static final java.lang.String DEFAULT_VERSION
public static final short PARAM
public static final short EXCEPTION
public static final short RETURN
public static final short AUTHOR
public static final short VERSION
public static final short REFERENCE
private java.lang.String description
private java.lang.String name
private short type
private JDocDescriptor(short type)
private JDocDescriptor(short type, java.lang.String name, java.lang.String desc)
name
- the name string for this descriptordesc
- the description string for this descriptorprotected short compareTo(JDocDescriptor jdd)
jdd
- the javadoc descriptorpublic static JDocDescriptor createAuthorDesc()
public static JDocDescriptor createAuthorDesc(java.lang.String name)
name
- the author name stringpublic static JDocDescriptor createExceptionDesc()
public static JDocDescriptor createExceptionDesc(java.lang.String name, java.lang.String desc)
name
- the exception namedesc
- the description of when the exception is calledpublic static JDocDescriptor createParamDesc()
public static JDocDescriptor createParamDesc(java.lang.String name, java.lang.String desc)
name
- the param namedesc
- the param description stringpublic static JDocDescriptor createReferenceDesc()
public static JDocDescriptor createReferenceDesc(java.lang.String name)
name
- the reference name stringpublic static JDocDescriptor createReturnDesc()
public static JDocDescriptor createReturnDesc(java.lang.String desc)
desc
- the return descriptionpublic static JDocDescriptor createVersionDesc()
public static JDocDescriptor createVersionDesc(java.lang.String version)
version
- the version stringpublic java.lang.String getDescription()
public java.lang.String getName()
public short getType()
public void setDescription(java.lang.String desc)
desc
- the description of the object being describedpublic void setName(java.lang.String name)
name
- the name value of the JavaDoc fieldpublic java.lang.String toString()
toString
in class java.lang.Object