org.acm.seguin.pretty
Interface JavaDocable

All Known Implementing Classes:

AnnotationMethodDeclaration, AnnotationTypeDeclaration, ClassDeclaration, ConstantDeclaration, ConstructorDeclaration, EnumDeclaration, FieldDeclaration, InterfaceDeclaration, JavaDocableImpl, MethodDeclaration, NestedClassDeclaration, NestedInterfaceDeclaration, PackageDeclaration

public interface JavaDocable

Possible to store java doc components

Author:

Chris Seguin

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

Method Detail

addJavaDocComponent

void addJavaDocComponent(JavaDocComponent component)

Allows you to add a java doc component

Parameters:

component - the component that can be added

printJavaDocComponents

void printJavaDocComponents(PrintData printData)

Prints all the java doc components

Parameters:

printData - the print data

finish

void finish()

Makes sure all the java doc components are present

isRequired

boolean isRequired()

Checks to see if it was printed

Returns:

true if it still needs to be printed