org.acm.seguin.pretty.jdi
Class PackageDeclaration

java.lang.Object
  org.acm.seguin.pretty.jdi.PackageDeclaration

All Implemented Interfaces:

JavaDocable

public class PackageDeclaration
extends java.lang.Object
implements JavaDocable

Holds the package declaration at the beginning of the java file

Since:

jRefactory 2.9.0, created October 16, 2003

Author:

Mike Atkinson

Constructor Summary

PackageDeclaration(net.sourceforge.jrefactory.ast.ASTPackageDeclaration pack)
Constructor for the PackageDeclaration 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

Constructor Detail

PackageDeclaration

public PackageDeclaration(net.sourceforge.jrefactory.ast.ASTPackageDeclaration pack)

Constructor for the PackageDeclaration JavaDoc creator.

Parameters:

pack - Create JavaDoc for this node.

Method Detail

isRequired

public boolean isRequired()

Checks to see if it was printed

Specified by:

isRequired in interface JavaDocable

Returns:

true if it still needs to be printed

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

printJavaDocComponents

public void printJavaDocComponents(PrintData printData)

Prints all the java doc components

Specified by:

printJavaDocComponents in interface JavaDocable

Parameters:

printData - the print data

finish

public void finish()

Makes sure all the java doc components are present

Specified by:

finish in interface JavaDocable