org.exolab.javasource

Class JDocComment


public final class JDocComment
extends java.lang.Object

A class that "SOMEWHAT" represents a JavaDoc Comment.
Version:
$Revision: 6324 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
Author:
Keith Visco

Constructor Summary

JDocComment()
Creates a new JavaDoc Comment.

Method Summary

void
addDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment.
void
appendComment(String comment)
Appends the provided comment String to this JDocComment.
String
getComment()
Returns the String value of this JDocComment.
Enumeration
getDescriptors()
Returns an Enumeration of the parameters of this JDocComment.
int
getLength()
Returns the length of the JavaDoc comment in characters.
JDocDescriptor
getParamDescriptor(String name)
Returns the Parameter Descriptor associated with the given name.
void
print(JSourceWriter jsw)
prints this JavaDoc comment using the given JSourceWriter.
void
setComment(String comment)
Sets the comment String of this JDocComment.
String
toString()
Returns the String representation of this JavaDoc comment.

Constructor Details

JDocComment

public JDocComment()
Creates a new JavaDoc Comment.

Method Details

addDescriptor

public void addDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment.
Parameters:
jdesc - the JDocDescriptor to add

appendComment

public void appendComment(String comment)
Appends the provided comment String to this JDocComment.
Parameters:
comment - the comment to append

getComment

public String getComment()
Returns the String value of this JDocComment.
Returns:
the String value of this JDocComment.

getDescriptors

public Enumeration getDescriptors()
Returns an Enumeration of the parameters of this JDocComment.
Returns:
an Enumeration of the parameters of this JDocComment.

getLength

public int getLength()
Returns the length of the JavaDoc comment in characters.
Returns:
the length of the JavaDoc comment in characters.

getParamDescriptor

public JDocDescriptor getParamDescriptor(String name)
Returns the Parameter Descriptor associated with the given name.
Parameters:
name - the name whose ParamDescriptor is being searched for
Returns:
the Parameter Descriptor associated with the given name.

print

public void print(JSourceWriter jsw)
prints this JavaDoc comment using the given JSourceWriter.
Parameters:
jsw - the JSourceWriter to print to

setComment

public void setComment(String comment)
Sets the comment String of this JDocComment.
Parameters:
comment - the comment String of this JDocComment

toString

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

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