org.acm.seguin.pretty.jdi
Class ClassDeclaration

java.lang.Object
  extended by org.acm.seguin.pretty.jdi.ClassDeclaration
All Implemented Interfaces:
JavaDocable

public class ClassDeclaration
extends java.lang.Object

Holds a class declaration. Contains the list of modifiers for the class and the javadoc comments.

Since:
jRefactory 2.9.0, created October 16, 2003
Author:
Mike Atkinson

Field Summary
protected  FileSettings bundle
           
protected  JavaDocableImpl jdi
           
 
Constructor Summary
ClassDeclaration(net.sourceforge.jrefactory.ast.ASTClassDeclaration clazz)
          Constructor for the ClassDeclaration JavaDoc creator.
 
Method Summary
 void addJavaDocComponent(JavaDocComponent component)
          Allows you to add a java doc component
 void finish()
          Makes sure all the java doc components are present.
 boolean isRequired()
          Checks to see if it was printed
 void printJavaDocComponents(PrintData printData)
          Prints all the java doc components
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

jdi

protected JavaDocableImpl jdi

bundle

protected FileSettings bundle
Constructor Detail

ClassDeclaration

public ClassDeclaration(net.sourceforge.jrefactory.ast.ASTClassDeclaration clazz)
Constructor for the ClassDeclaration JavaDoc creator.

Parameters:
clazz - Create JavaDoc for this node.
Method Detail

isRequired

public boolean isRequired()
Checks to see if it was printed

Returns:
true if it still needs to be printed

printJavaDocComponents

public void printJavaDocComponents(PrintData printData)
Prints all the java doc components

Parameters:
printData - the print data

finish

public void finish()
Makes sure all the java doc components are present. For classes and interfaces, this means a date and an author.


addJavaDocComponent

public void addJavaDocComponent(JavaDocComponent component)
Allows you to add a java doc component

Specified by:
addJavaDocComponent in interface JavaDocable
Parameters:
component - the component that can be added