org.codehaus.groovy.tools.groovydoc
Class SimpleGroovyClassDocAssembler

java.lang.Object
  org.codehaus.groovy.antlr.treewalker.VisitorAdapter
      org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDocAssembler

All Implemented Interfaces:

Visitor

public class SimpleGroovyClassDocAssembler
extends VisitorAdapter

Field Summary

private java.util.Map	classDocs
private SimpleGroovyClassDoc	currentClassDoc
private SimpleGroovyConstructorDoc	currentConstructorDoc
private SimpleGroovyMethodDoc	currentMethodDoc
private static java.lang.String	FS
private java.util.List	importedClassesAndPackages
private java.util.List	links
private java.lang.String	packagePath
private java.util.regex.Pattern	previousJavaDocCommentPattern
private SourceBuffer	sourceBuffer
private java.util.Stack	stack

Fields inherited from interface org.codehaus.groovy.antlr.treewalker.Visitor

CLOSING_VISIT, OPENING_VISIT, SECOND_VISIT, SUBSEQUENT_VISIT

Constructor Summary

SimpleGroovyClassDocAssembler(java.lang.String packagePath, java.lang.String file, SourceBuffer sourceBuffer, java.util.List links)

Method Summary

private void	addParametersTo(SimpleGroovyExecutableMemberDoc executableMemberDoc, GroovySourceAST t, int visit)
private GroovySourceAST	getGrandParentNode()
java.util.Map	getGroovyClassDocs()
private java.lang.String	getJavaDocCommentsBeforeNode(GroovySourceAST t)
private GroovySourceAST	getParentNode()
private java.lang.String	getText(GroovySourceAST node)
private java.lang.String	getTypeNodeAsText(GroovySourceAST typeNode, java.lang.String defaultText)
private boolean	insideAnonymousInnerClass()
GroovySourceAST	pop()
private void	postProcessClassDocs()
private void	processModifiers(GroovySourceAST t, SimpleGroovyProgramElementDoc programElementDoc)
void	push(GroovySourceAST t)
java.lang.String	recurseDownImportBranch(GroovySourceAST t)
void	visitClassDef(GroovySourceAST t, int visit)
void	visitCtorIdent(GroovySourceAST t, int visit)
void	visitExtendsClause(GroovySourceAST t, int visit)
void	visitImport(GroovySourceAST t, int visit)
void	visitInterfaceDef(GroovySourceAST t, int visit)
void	visitMethodDef(GroovySourceAST t, int visit)
void	visitVariableDef(GroovySourceAST t, int visit)

Methods inherited from class org.codehaus.groovy.antlr.treewalker.VisitorAdapter

setUp, tearDown, visitAbstract, visitAnnotation, visitAnnotationArrayInit, visitAnnotationDef, visitAnnotationFieldDef, visitAnnotationMemberValuePair, visitAnnotations, visitArrayDeclarator, visitAssign, visitAt, visitBand, visitBandAssign, visitBigSuffix, visitBlock, visitBnot, visitBor, visitBorAssign, visitBsr, visitBsrAssign, visitBxor, visitBxorAssign, visitCaseGroup, visitClosedBlock, visitClosureList, visitClosureOp, visitColon, visitComma, visitCompareTo, visitCtorCall, visitDec, visitDefault, visitDigit, visitDiv, visitDivAssign, visitDollar, visitDot, visitDynamicMember, visitElist, visitEmptyStat, visitEnumConstantDef, visitEnumDef, visitEof, visitEqual, visitEsc, visitExponent, visitExpr, visitFinal, visitFloatSuffix, visitForCondition, visitForEachClause, visitForInit, visitForInIterable, visitForIterator, visitGe, visitGt, visitHexDigit, visitIdent, visitImplementsClause, visitImplicitParameters, visitInc, visitIndexOp, visitInstanceInit, visitLabeledArg, visitLabeledStat, visitLand, visitLbrack, visitLcurly, visitLe, visitLetter, visitListConstructor, visitLiteralAs, visitLiteralAssert, visitLiteralBoolean, visitLiteralBreak, visitLiteralByte, visitLiteralCase, visitLiteralCatch, visitLiteralChar, visitLiteralClass, visitLiteralContinue, visitLiteralDef, visitLiteralDefault, visitLiteralDouble, visitLiteralElse, visitLiteralEnum, visitLiteralExtends, visitLiteralFalse, visitLiteralFinally, visitLiteralFloat, visitLiteralFor, visitLiteralIf, visitLiteralImplements, visitLiteralImport, visitLiteralIn, visitLiteralInstanceof, visitLiteralInt, visitLiteralInterface, visitLiteralLong, visitLiteralNative, visitLiteralNew, visitLiteralNull, visitLiteralPackage, visitLiteralPrivate, visitLiteralProtected, visitLiteralPublic, visitLiteralReturn, visitLiteralShort, visitLiteralStatic, visitLiteralSuper, visitLiteralSwitch, visitLiteralSynchronized, visitLiteralThis, visitLiteralThreadsafe, visitLiteralThrow, visitLiteralThrows, visitLiteralTransient, visitLiteralTrue, visitLiteralTry, visitLiteralVoid, visitLiteralVolatile, visitLiteralWhile, visitLnot, visitLor, visitLparen, visitLt, visitMapConstructor, visitMemberPointer, visitMethodCall, visitMinus, visitMinusAssign, visitMlComment, visitMod, visitModAssign, visitModifiers, visitNls, visitNotEqual, visitNullTreeLookahead, visitNumBigDecimal, visitNumBigInt, visitNumDouble, visitNumFloat, visitNumInt, visitNumLong, visitObjblock, visitOneNl, visitOptionalDot, visitPackageDef, visitParameterDef, visitParameters, visitPlus, visitPlusAssign, visitPostDec, visitPostInc, visitQuestion, visitRangeExclusive, visitRangeInclusive, visitRbrack, visitRcurly, visitRegexFind, visitRegexMatch, visitRegexpCtorEnd, visitRegexpLiteral, visitRegexpSymbol, visitRparen, visitSelectSlot, visitSemi, visitShComment, visitSl, visitSlAssign, visitSlComment, visitSlist, visitSpreadArg, visitSpreadDot, visitSpreadMapArg, visitSr, visitSrAssign, visitStar, visitStarAssign, visitStarStar, visitStarStarAssign, visitStaticImport, visitStaticInit, visitStrictfp, visitStringCh, visitStringConstructor, visitStringCtorEnd, visitStringCtorMiddle, visitStringCtorStart, visitStringLiteral, visitStringNl, visitSuperCtorCall, visitTripleDot, visitType, visitTypeArgument, visitTypeArguments, visitTypecast, visitTypeLowerBounds, visitTypeParameter, visitTypeParameters, visitTypeUpperBounds, visitUnaryMinus, visitUnaryPlus, visitUnusedConst, visitUnusedDo, visitUnusedGoto, visitVariableParameterDef, visitVocab, visitWildcardType, visitWs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stack

private java.util.Stack stack

classDocs

private java.util.Map classDocs

currentClassDoc

private SimpleGroovyClassDoc currentClassDoc

currentConstructorDoc

private SimpleGroovyConstructorDoc currentConstructorDoc

currentMethodDoc

private SimpleGroovyMethodDoc currentMethodDoc

sourceBuffer

private SourceBuffer sourceBuffer

packagePath

private java.lang.String packagePath

previousJavaDocCommentPattern

private java.util.regex.Pattern previousJavaDocCommentPattern

FS

private static final java.lang.String FS

See Also:

Constant Field Values

importedClassesAndPackages

private java.util.List importedClassesAndPackages

links

private java.util.List links

Constructor Detail

SimpleGroovyClassDocAssembler

public SimpleGroovyClassDocAssembler(java.lang.String packagePath,
                                     java.lang.String file,
                                     SourceBuffer sourceBuffer,
                                     java.util.List links)

Method Detail

getGroovyClassDocs

public java.util.Map getGroovyClassDocs()

postProcessClassDocs

private void postProcessClassDocs()

visitInterfaceDef

public void visitInterfaceDef(GroovySourceAST t,
                              int visit)

Specified by:

visitInterfaceDef in interface Visitor

Overrides:

visitInterfaceDef in class VisitorAdapter

visitImport

public void visitImport(GroovySourceAST t,
                        int visit)

Specified by:

visitImport in interface Visitor

Overrides:

visitImport in class VisitorAdapter

recurseDownImportBranch

public java.lang.String recurseDownImportBranch(GroovySourceAST t)

visitExtendsClause

public void visitExtendsClause(GroovySourceAST t,
                               int visit)

Specified by:

visitExtendsClause in interface Visitor

Overrides:

visitExtendsClause in class VisitorAdapter

visitClassDef

public void visitClassDef(GroovySourceAST t,
                          int visit)

Specified by:

visitClassDef in interface Visitor

Overrides:

visitClassDef in class VisitorAdapter

visitCtorIdent

public void visitCtorIdent(GroovySourceAST t,
                           int visit)

Specified by:

visitCtorIdent in interface Visitor

Overrides:

visitCtorIdent in class VisitorAdapter

visitMethodDef

public void visitMethodDef(GroovySourceAST t,
                           int visit)

Specified by:

visitMethodDef in interface Visitor

Overrides:

visitMethodDef in class VisitorAdapter

visitVariableDef

public void visitVariableDef(GroovySourceAST t,
                             int visit)

Specified by:

visitVariableDef in interface Visitor

Overrides:

visitVariableDef in class VisitorAdapter

insideAnonymousInnerClass

private boolean insideAnonymousInnerClass()

processModifiers

private void processModifiers(GroovySourceAST t,
                              SimpleGroovyProgramElementDoc programElementDoc)

getJavaDocCommentsBeforeNode

private java.lang.String getJavaDocCommentsBeforeNode(GroovySourceAST t)

getText

private java.lang.String getText(GroovySourceAST node)

getTypeNodeAsText

private java.lang.String getTypeNodeAsText(GroovySourceAST typeNode,
                                           java.lang.String defaultText)

addParametersTo

private void addParametersTo(SimpleGroovyExecutableMemberDoc executableMemberDoc,
                             GroovySourceAST t,
                             int visit)

push

public void push(GroovySourceAST t)

Specified by:

push in interface Visitor

Overrides:

push in class VisitorAdapter

pop

public GroovySourceAST pop()

Specified by:

pop in interface Visitor

Overrides:

pop in class VisitorAdapter

getParentNode

private GroovySourceAST getParentNode()

getGrandParentNode

private GroovySourceAST getGrandParentNode()