org.brains2b.typewriter

Class JavaDocTemplate

java.lang.Object

org.brains2b.typewriter.CommentTemplate

org.brains2b.typewriter.JavaDocTemplate

All Implemented Interfaces:

Template

public class JavaDocTemplate
extends CommentTemplate

Field Summary

Fields inherited from class org.brains2b.typewriter.CommentTemplate

m_content

Constructor Summary

Constructors

Constructor and Description
JavaDocTemplate()

Method Summary

Modifier and Type	Method and Description
void	addTag(JavaDocTag tag, java.lang.String value)
void	setDescription(JavaDocTag tag, java.lang.String key, java.lang.String value)
void	write(java.io.PrintWriter writer, int indent) write the template information to the PrintWriter at the given indention.

Methods inherited from class org.brains2b.typewriter.CommentTemplate

addImport, addText, getContent, getParent, setContent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocTemplate

public JavaDocTemplate()

Method Detail

setDescription

public void setDescription(JavaDocTag tag,
                           java.lang.String key,
                           java.lang.String value)

addTag

public void addTag(JavaDocTag tag,
                   java.lang.String value)

write

public void write(java.io.PrintWriter writer,
                  int indent)

write the template information to the PrintWriter at the given indention.

Indention is multiplied by 4 to supply the spaces for the indention.

Specified by:

write in interface Template

Overrides:

write in class CommentTemplate

Parameters:

writer - PrintWriter, an initialized PrintWriter to write this element of the Class to

indent - int, the indention for this element.

Value is multiplied by four to give the number of spaces used for indention