org.apache.ws.jaxme.js
Class JavaComment
java.lang.Object
org.apache.ws.jaxme.js.JavaComment
public class JavaComment
extends java.lang.Object
A class representing a Java comment.
void | addAuthor(String author) - Sets the JavaDoc author field.
|
void | addLine(String s) - Adds a line to the comments content.
|
void | addParam(String s) - Adds a JavaDoc "param" field.
|
void | addSee(String pSee) - Adds an element to the list of Strings which should be used for
"see" fields.
|
void | addThrows(String s) - Adds a JavaDoc "throw" field.
|
List | getAuthors() - Returns the JavaDoc author field or null, if there is no
author field.
|
ArrayList | getLines() - Returns an array of lines being the comments content.
|
List | getParams() - Returns an array of values for the JavaDoc param field.
|
String | getReturn() - Returns the JavaDoc return field or null, if there is no
return field.
|
List | getSee() - Returns an array list of Strings which should be used for "see" fields.
|
List | getThrows() - Returns an array of values for the JavaDoc throw field.
|
String | getVersion() - Returns the JavaDoc version field or null, if there is no
version field.
|
void | setReturn(String pReturns) - Sets the JavaDoc return field.
|
void | setVersion(String pVersion) - Sets the JavaDoc version field.
|
void | write(IndentationTarget pTarget) - Returns a string representation of this comment.
|
addAuthor
public void addAuthor(String author)
Sets the JavaDoc author field. Use null to disable the author field.
addLine
public void addLine(String s)
Adds a line to the comments content.
addParam
public void addParam(String s)
Adds a JavaDoc "param" field.
addSee
public void addSee(String pSee)
Adds an element to the list of Strings which should be used for
"see" fields.
addThrows
public void addThrows(String s)
Adds a JavaDoc "throw" field.
getAuthors
public List getAuthors()
Returns the JavaDoc author field or null, if there is no
author field.
getLines
public ArrayList getLines()
Returns an array of lines being the comments content.
getParams
public List getParams()
Returns an array of values for the JavaDoc param field.
getReturn
public String getReturn()
Returns the JavaDoc return field or null, if there is no
return field.
getSee
public List getSee()
Returns an array list of Strings which should be used for "see" fields.
getThrows
public List getThrows()
Returns an array of values for the JavaDoc throw field.
getVersion
public String getVersion()
Returns the JavaDoc version field or null, if there is no
version field.
setReturn
public void setReturn(String pReturns)
Sets the JavaDoc return field. Use null to disable the return field.
setVersion
public void setVersion(String pVersion)
Sets the JavaDoc version field. Use null to disable the version field.
write
public void write(IndentationTarget pTarget)
throws IOException
Returns a string representation of this comment.