org.codehaus.modello.generator.java.javasource

Class JDocComment

public class JDocComment extends Object

A class that "SOMEWHAT" represents a Java Doc Comment.

Version: $Revision: 149 $ $Date: 2004-09-29 13:32:16 -0400 (Wed, 29 Sep 2004) $

Author: Keith Visco

Constructor Summary
JDocComment()
Creates a new JavaDoc Comment
Method Summary
voidaddDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment
voidappendComment(String comment)
Appends the comment String to this JDocComment
StringgetComment()
Returns the String value of this JDocComment.
EnumerationgetDescriptors()
Returns an enumeration of the parameters of this JDocComment
intgetLength()
Returns the length of the comment
JDocDescriptorgetParamDescriptor(String name)
Returns the Parameter Descriptor associated with the given name
voidprint(JSourceWriter jsw)
prints this JavaDoc comment using the given JSourceWriter
voidsetComment(String comment)
Sets the comment String of this JDocComment
StringtoString()
Returns the String representation of this Java Doc Comment

Constructor Detail

JDocComment

public JDocComment()
Creates a new JavaDoc Comment

Method Detail

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

Returns: the length of the comment

getParamDescriptor

public JDocDescriptor getParamDescriptor(String name)
Returns the Parameter Descriptor associated with the given name

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 Java Doc Comment

Returns: the String representation of this Java Doc Comment

Copyright © 2001-2009 Codehaus. All Rights Reserved.