net.sf.jaxme.js
Class JavaComment

java.lang.Object
  net.sf.jaxme.js.JavaComment

public class JavaComment

extends java.lang.Object

A class representing a Java comment.

Author:

Jochen Wiedmann

Method Summary

void	addAuthor(java.lang.String author) Sets the JavaDoc author field.
void	addLine(java.lang.String s) Adds a line to the comments content.
void	addParam(java.lang.String s) Adds a JavaDoc "param" field.
void	addSee(java.lang.String pSee) Adds an element to the list of Strings which should be used for "see" fields.
void	addThrows(java.lang.String s) Adds a JavaDoc "throw" field.
java.util.List	getAuthors() Returns the JavaDoc author field or null, if there is no author field.
java.util.ArrayList	getLines() Returns an array of lines being the comments content.
java.util.List	getParams() Returns an array of values for the JavaDoc param field.
java.lang.String	getReturn() Returns the JavaDoc return field or null, if there is no return field.
java.util.List	getSee() Returns an array list of Strings which should be used for "see" fields.
java.util.List	getThrows() Returns an array of values for the JavaDoc throw field.
java.lang.String	getVersion() Returns the JavaDoc version field or null, if there is no version field.
void	setReturn(java.lang.String pReturns) Sets the JavaDoc return field.
void	setVersion(java.lang.String pVersion) Sets the JavaDoc version field.
void	write(IndentationTarget pTarget) Returns a string representation of this comment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAuthors

public java.util.List getAuthors()

Returns the JavaDoc author field or null, if there is no author field.

See Also:

addAuthor(java.lang.String)

addAuthor

public void addAuthor(java.lang.String author)

Sets the JavaDoc author field. Use null to disable the author field.

See Also:

getAuthors()

getVersion

public java.lang.String getVersion()

Returns the JavaDoc version field or null, if there is no version field.

See Also:

setVersion(java.lang.String)

setVersion

public void setVersion(java.lang.String pVersion)

Sets the JavaDoc version field. Use null to disable the version field.

See Also:

getVersion()

getReturn

public java.lang.String getReturn()

Returns the JavaDoc return field or null, if there is no return field.

See Also:

setReturn(java.lang.String)

setReturn

public void setReturn(java.lang.String pReturns)

Sets the JavaDoc return field. Use null to disable the return field.

See Also:

getReturn()

getSee

public java.util.List getSee()

Returns an array list of Strings which should be used for "see" fields.

See Also:

addSee(java.lang.String)

addSee

public void addSee(java.lang.String pSee)

Adds an element to the list of Strings which should be used for "see" fields.

See Also:

getSee()

getLines

public java.util.ArrayList getLines()

Returns an array of lines being the comments content.

See Also:

addLine(java.lang.String)

addLine

public void addLine(java.lang.String s)

Adds a line to the comments content.

See Also:

getLines()

getParams

public java.util.List getParams()

Returns an array of values for the JavaDoc param field.

See Also:

addParam(java.lang.String)

addParam

public void addParam(java.lang.String s)

Adds a JavaDoc "param" field.

See Also:

getParams()

getThrows

public java.util.List getThrows()

Returns an array of values for the JavaDoc throw field.

See Also:

addThrows(java.lang.String)

addThrows

public void addThrows(java.lang.String s)

Adds a JavaDoc "throw" field.

See Also:

getThrows()

write

public void write(IndentationTarget pTarget)
           throws java.io.IOException

Returns a string representation of this comment.

Throws:

java.io.IOException