|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.acm.seguin.pretty.JavaDocableImpl
public class JavaDocableImpl
Stores the java doc components
Constructor Summary | |
---|---|
JavaDocableImpl()
Constructor |
Method Summary | |
---|---|
void |
addJavaDocComponent(JavaDocComponent component)
Allows you to add a java doc component |
boolean |
contains(java.lang.String type)
Contains a particular item |
boolean |
contains(java.lang.String type,
java.lang.String id)
Contains a particular item |
void |
finish()
Makes sure all the java doc components are present |
boolean |
isPrinted()
Determines 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 |
void |
printJavaDocComponents(PrintData printData,
java.lang.String order)
Prints all the java doc components |
void |
require(java.lang.String tag,
java.lang.String descr)
Make a required field |
void |
require(java.lang.String tag,
java.lang.String id,
java.lang.String descr)
Make a required field |
void |
sort(java.lang.String type,
java.lang.String[] names)
Allows you to sort the javadoc tags. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavaDocableImpl()
Method Detail |
---|
public boolean isRequired()
isRequired
in interface JavaDocable
public boolean isPrinted()
public void addJavaDocComponent(JavaDocComponent component)
addJavaDocComponent
in interface JavaDocable
component
- the component that can be addedpublic void sort(java.lang.String type, java.lang.String[] names)
type
- The "@"tag to sort (e.g. "@param").names
- The order of identifies desired after sort (e.g. for this method {"type", "names"} ).public void printJavaDocComponents(PrintData printData)
printJavaDocComponents
in interface JavaDocable
printData
- the print datapublic void printJavaDocComponents(PrintData printData, java.lang.String order)
printData
- the print dataorder
- the order for the tagspublic void finish()
finish
in interface JavaDocable
public boolean contains(java.lang.String type)
type
- the type we are looking for
public boolean contains(java.lang.String type, java.lang.String id)
type
- the type we are looking forid
- the id
public void require(java.lang.String tag, java.lang.String descr)
tag
- the tagdescr
- the default descriptionpublic void require(java.lang.String tag, java.lang.String id, java.lang.String descr)
tag
- the tagid
- the iddescr
- the default description
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |