Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions

org.exolab.javasource.JDocDescriptor Class Reference

List of all members.

Public Member Functions

String getDescription ()
String getName ()
short getType ()
void setDescription (String desc)
void setName (String name)
String toString ()

Static Public Member Functions

static JDocDescriptor createAuthorDesc ()
static JDocDescriptor createAuthorDesc (String name)
static JDocDescriptor createExceptionDesc ()
static JDocDescriptor createExceptionDesc (String name, String desc)
static JDocDescriptor createParamDesc ()
static JDocDescriptor createParamDesc (String name, String desc)
static JDocDescriptor createReferenceDesc ()
static JDocDescriptor createReferenceDesc (String name)
static JDocDescriptor createReturnDesc ()
static JDocDescriptor createReturnDesc (String desc)
static JDocDescriptor createVersionDesc ()
static JDocDescriptor createVersionDesc (String version)

Static Public Attributes

static final String DEFAULT_VERSION = "$"
static final short PARAM = 0
static final short EXCEPTION = 1
static final short RETURN = 2
static final short AUTHOR = 3
static final short VERSION = 4
static final short REFERENCE = 5

Protected Member Functions

short compareTo (JDocDescriptor jdd)

Detailed Description

A descriptor for a JavaDoc comment

Author:
Keith Visco
Version:
Revision:
1.1.1.1
Date:
2003/03/03 07:09:54

Member Function Documentation

short org.exolab.javasource.JDocDescriptor.compareTo ( JDocDescriptor  jdd  )  [protected]

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

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

References org.exolab.javasource.JDocDescriptor.getType().

Referenced by org.exolab.javasource.JDocComment.addDescriptor().

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createAuthorDesc (  )  [static]

Creates a new author descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.AUTHOR.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createAuthorDesc ( String  name  )  [static]

Creates a new author descriptor

Parameters:
name the author name string
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.AUTHOR.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createExceptionDesc (  )  [static]

Creates a new exception descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.EXCEPTION.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createExceptionDesc ( String  name,
String  desc 
) [static]

Creates a new exception descriptor

Parameters:
name the exception name
desc the description of when the exception is called
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.EXCEPTION.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createParamDesc (  )  [static]

Creates a new param descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.PARAM.

Referenced by org.exolab.castor.builder.FieldInfo.createSetterComment().

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createParamDesc ( String  name,
String  desc 
) [static]

Creates a new param descriptor

Parameters:
name the param name
desc the param description string
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.PARAM.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createReferenceDesc (  )  [static]

Creates a new reference descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.REFERENCE.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createReferenceDesc ( String  name  )  [static]

Creates a new reference descriptor

Parameters:
name the reference name string
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.REFERENCE.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createReturnDesc (  )  [static]

Creates a new return descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.RETURN.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createReturnDesc ( String  desc  )  [static]

Creates a new return descriptor

Parameters:
desc the return description
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.RETURN.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createVersionDesc (  )  [static]

Creates a new version descriptor

Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.VERSION.

static JDocDescriptor org.exolab.javasource.JDocDescriptor.createVersionDesc ( String  version  )  [static]

Creates a new version descriptor

Parameters:
version the version string
Returns:
the new JDocDescriptor

References org.exolab.javasource.JDocDescriptor.VERSION.

String org.exolab.javasource.JDocDescriptor.getDescription (  ) 

Returns the description String for this descriptor

Returns:
the description string for this descriptor
String org.exolab.javasource.JDocDescriptor.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

Referenced by org.exolab.javasource.JDocComment.getParamDescriptor().

short org.exolab.javasource.JDocDescriptor.getType (  ) 

Returns the type of this JDocDescriptor

Returns:
the type of this JDocDescriptor

Referenced by org.exolab.javasource.JDocDescriptor.compareTo(), and org.exolab.javasource.JDocComment.getParamDescriptor().

void org.exolab.javasource.JDocDescriptor.setDescription ( String  desc  ) 

Sets the description String for this descriptor

Parameters:
desc the description of the object being described

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createGetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createGetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionReferenceMethod(), and org.exolab.castor.builder.FieldInfo.createSetterComment().

void org.exolab.javasource.JDocDescriptor.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
String org.exolab.javasource.JDocDescriptor.toString (  ) 

Returns the String representation of this JDocDescriptor

Returns:
the String representation of this JDocDescriptor

References org.exolab.javasource.JDocDescriptor.AUTHOR, org.exolab.javasource.JDocDescriptor.EXCEPTION, org.exolab.javasource.JDocDescriptor.PARAM, org.exolab.javasource.JDocDescriptor.REFERENCE, org.exolab.javasource.JDocDescriptor.RETURN, and org.exolab.javasource.JDocDescriptor.VERSION.

Member Data Documentation

final short org.exolab.javasource.JDocDescriptor.AUTHOR = 3 [static]

The author descriptor

Referenced by org.exolab.javasource.JDocDescriptor.createAuthorDesc(), and org.exolab.javasource.JDocDescriptor.toString().

final String org.exolab.javasource.JDocDescriptor.DEFAULT_VERSION = "$" [static]

The default version string

final short org.exolab.javasource.JDocDescriptor.EXCEPTION = 1 [static]

The exception descriptor (exception)

Referenced by org.exolab.javasource.JDocDescriptor.createExceptionDesc(), and org.exolab.javasource.JDocDescriptor.toString().

final short org.exolab.javasource.JDocDescriptor.PARAM = 0 [static]

The param descriptor (param)

Referenced by org.exolab.javasource.JDocDescriptor.createParamDesc(), and org.exolab.javasource.JDocDescriptor.toString().

final short org.exolab.javasource.JDocDescriptor.REFERENCE = 5 [static]

The reference descriptor (see)

Referenced by org.exolab.javasource.JDocDescriptor.createReferenceDesc(), and org.exolab.javasource.JDocDescriptor.toString().

final short org.exolab.javasource.JDocDescriptor.RETURN = 2 [static]

The return descriptor (return)

Referenced by org.exolab.javasource.JDocDescriptor.createReturnDesc(), and org.exolab.javasource.JDocDescriptor.toString().

final short org.exolab.javasource.JDocDescriptor.VERSION = 4 [static]

the version descriptor (version)

Referenced by org.exolab.javasource.JDocDescriptor.createVersionDesc(), and org.exolab.javasource.JDocDescriptor.toString().

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:16:03 for ACS-10.0 Java API by  doxygen 1.7.0