org.codehaus.groovy.tools.groovydoc
Class SimpleGroovyPackageDoc

java.lang.Object
  extended by org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
      extended by org.codehaus.groovy.tools.groovydoc.SimpleGroovyPackageDoc
All Implemented Interfaces:
java.lang.Comparable, GroovyDoc, GroovyPackageDoc

public class SimpleGroovyPackageDoc
extends SimpleGroovyDoc
implements GroovyPackageDoc


Field Summary
(package private)  java.util.Map classDocs
           
private static char FS
           
 
Constructor Summary
SimpleGroovyPackageDoc(java.lang.String name)
           
 
Method Summary
 GroovyClassDoc[] allClasses()
           
 GroovyClassDoc[] allClasses(boolean arg0)
           
 GroovyClassDoc[] enums()
           
 GroovyClassDoc[] errors()
           
 GroovyClassDoc[] exceptions()
           
 GroovyClassDoc findClass(java.lang.String arg0)
           
 java.lang.String getRelativeRootPath()
           
 GroovyClassDoc[] interfaces()
           
 java.lang.String nameWithDots()
           
 GroovyClassDoc[] ordinaryClasses()
           
 void putAll(java.util.Map classes)
           
 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
commentText, compareTo, firstSentenceCommentText, getDocUrl, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, replaceAllTags, setAsInterfaceDefinition, setRawCommentText, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoc
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

FS

private static final char FS
See Also:
Constant Field Values

classDocs

final java.util.Map classDocs
Constructor Detail

SimpleGroovyPackageDoc

public SimpleGroovyPackageDoc(java.lang.String name)
Method Detail

allClasses

public GroovyClassDoc[] allClasses()
Specified by:
allClasses in interface GroovyPackageDoc

putAll

public void putAll(java.util.Map classes)

nameWithDots

public java.lang.String nameWithDots()
Specified by:
nameWithDots in interface GroovyPackageDoc

allClasses

public GroovyClassDoc[] allClasses(boolean arg0)
Specified by:
allClasses in interface GroovyPackageDoc

enums

public GroovyClassDoc[] enums()
Specified by:
enums in interface GroovyPackageDoc

errors

public GroovyClassDoc[] errors()
Specified by:
errors in interface GroovyPackageDoc

exceptions

public GroovyClassDoc[] exceptions()
Specified by:
exceptions in interface GroovyPackageDoc

findClass

public GroovyClassDoc findClass(java.lang.String arg0)
Specified by:
findClass in interface GroovyPackageDoc

interfaces

public GroovyClassDoc[] interfaces()
Specified by:
interfaces in interface GroovyPackageDoc

ordinaryClasses

public GroovyClassDoc[] ordinaryClasses()
Specified by:
ordinaryClasses in interface GroovyPackageDoc

getRelativeRootPath

public java.lang.String getRelativeRootPath()
Specified by:
getRelativeRootPath in interface GroovyPackageDoc


Copyright © ${year} The Codehaus. All Rights Reserved.