org.acm.seguin.pretty.jdi
Class ConstantDeclaration

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

public class ConstantDeclaration
extends java.lang.Object

Holds a field declaration. The two components that this structure store are the modifiers to the field and any javadoc comments associated with the field.

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

Field Summary
protected  FileSettings bundle
           
protected  JavaDocableImpl jdi
           
 
Constructor Summary
ConstantDeclaration(net.sourceforge.jrefactory.ast.ASTConstantDeclaration field)
          Constructor for the ConstantDeclaration 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 isJavadocPrinted()
          Return true if the javadoc comments were printed
 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

ConstantDeclaration

public ConstantDeclaration(net.sourceforge.jrefactory.ast.ASTConstantDeclaration field)
Constructor for the ConstantDeclaration JavaDoc creator.

Parameters:
field - 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

isJavadocPrinted

public boolean isJavadocPrinted()
Return true if the javadoc comments were printed

Returns:
The javadocPrinted value

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


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