org.apache.ws.jaxme.js

Class JavaComment

public class JavaComment extends Object

A class representing a Java comment.

Author: Jochen Wiedmann

Method Summary
voidaddAuthor(String author)

Sets the JavaDoc author field.

voidaddLine(String s)

Adds a line to the comments content.

voidaddParam(String s)

Adds a JavaDoc "param" field.

voidaddSee(String pSee)

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

voidaddThrows(String s)

Adds a JavaDoc "throw" field.

ListgetAuthors()

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

ArrayListgetLines()

Returns an array of lines being the comments content.

ListgetParams()

Returns an array of values for the JavaDoc param field.

StringgetReturn()

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

ListgetSee()

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

ListgetThrows()

Returns an array of values for the JavaDoc throw field.

StringgetVersion()

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

voidsetReturn(String pReturns)

Sets the JavaDoc return field.

voidsetVersion(String pVersion)

Sets the JavaDoc version field.

voidwrite(IndentationTarget pTarget)

Returns a string representation of this comment.

Method Detail

addAuthor

public void addAuthor(String author)

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

See Also: JavaComment

addLine

public void addLine(String s)

Adds a line to the comments content.

See Also: JavaComment

addParam

public void addParam(String s)

Adds a JavaDoc "param" field.

See Also: JavaComment

addSee

public void addSee(String pSee)

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

See Also: JavaComment

addThrows

public void addThrows(String s)

Adds a JavaDoc "throw" field.

See Also: JavaComment

getAuthors

public List getAuthors()

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

See Also: JavaComment

getLines

public ArrayList getLines()

Returns an array of lines being the comments content.

See Also: JavaComment

getParams

public List getParams()

Returns an array of values for the JavaDoc param field.

See Also: JavaComment

getReturn

public String getReturn()

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

See Also: JavaComment

getSee

public List getSee()

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

See Also: JavaComment

getThrows

public List getThrows()

Returns an array of values for the JavaDoc throw field.

See Also: JavaComment

getVersion

public String getVersion()

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

See Also: JavaComment

setReturn

public void setReturn(String pReturns)

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

See Also: JavaComment

setVersion

public void setVersion(String pVersion)

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

See Also: JavaComment

write

public void write(IndentationTarget pTarget)

Returns a string representation of this comment.