de.ispsoft.jaxme.generator.javasource
Class JavaComment

java.lang.Object
  de.ispsoft.jaxme.generator.javasource.JavaComment

public class JavaComment

extends java.lang.Object

A class representing a Java comment.

Author:

Jochen Wiedmann

Constructor Summary

JavaComment()
Creates a new JavaComment which ought to be included into JavaDoc.

JavaComment(boolean javaDoc)
Creates a new JavaComment.

Method Summary

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.lang.String	getAuthor() 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.ArrayList	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.ArrayList	getSee() Returns an array list of Strings which should be used for "see" fields.
java.util.ArrayList	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	setAuthor(java.lang.String author) Sets the JavaDoc author field.
void	setReturn(java.lang.String returns) Sets the JavaDoc return field.
void	setVersion(java.lang.String version) Sets the JavaDoc version field.
java.lang.String	toString(int indent) 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

Constructor Detail

JavaComment

public JavaComment()

Creates a new JavaComment which ought to be included into JavaDoc. Use JavaComment(false) for comments which should be excluded.

JavaComment

public JavaComment(boolean javaDoc)

Creates a new JavaComment.

Parameters:

javaDoc - True, if this comment should appear in JavaDoc, false otherwise

Method Detail

getAuthor

public java.lang.String getAuthor()

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

See Also:

setAuthor(java.lang.String)

setAuthor

public void setAuthor(java.lang.String author)

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

See Also:

getAuthor()

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 version)

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 returns)

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

See Also:

getReturn()

getSee

public java.util.ArrayList 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.ArrayList 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.ArrayList 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()

toString

public java.lang.String toString(int indent)

Returns a string representation of this comment.