Package org.codehaus.groovy.groovydoc
Interface GroovyPackageDoc
- 
- All Superinterfaces:
- java.lang.Comparable,- GroovyDoc
 - All Known Implementing Classes:
- SimpleGroovyPackageDoc
 
 public interface GroovyPackageDoc extends GroovyDoc 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description GroovyClassDoc[]allClasses()All included classes and interfaces in this package.GroovyClassDoc[]allClasses(boolean filter)All classes and interfaces in this package optionally limited to just the included ones.java.lang.Stringdescription()Description of the package.GroovyClassDoc[]enums()Included enum types in this package.GroovyClassDoc[]errors()Included errors in this package.GroovyClassDoc[]exceptions()Included exceptions in this package.GroovyClassDocfindClass(java.lang.String className)Find a class or interface within this package.java.lang.StringgetRelativeRootPath()GroovyClassDoc[]interfaces()Included interfaces in this package.java.lang.StringnameWithDots()GroovyClassDoc[]ordinaryClasses()Included ordinary classes in this package.java.lang.Stringsummary()The one-sentence summary for the package derived from the beginning of the description.- 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoccommentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
 
- 
 
- 
- 
- 
Method Detail- 
allClassesGroovyClassDoc[] allClasses() All included classes and interfaces in this package.- Returns:
- array of classes and interfaces found or empty array if none found
 
 - 
allClassesGroovyClassDoc[] allClasses(boolean filter) All classes and interfaces in this package optionally limited to just the included ones.- Parameters:
- filter- Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.
- Returns:
- array of classes and interfaces found or empty array if none found
 
 - 
enumsGroovyClassDoc[] enums() Included enum types in this package.- Returns:
- array of enum types found or empty array if none found
 
 - 
errorsGroovyClassDoc[] errors() Included errors in this package.- Returns:
- array of errors found or empty array if none found
 
 - 
exceptionsGroovyClassDoc[] exceptions() Included exceptions in this package.- Returns:
- array of exceptions found or empty array if none found
 
 - 
findClassGroovyClassDoc findClass(java.lang.String className) Find a class or interface within this package.- Parameters:
- className- the name of the class to find
- Returns:
- ClassDoc of found class or interface, or null if not found
 
 - 
interfacesGroovyClassDoc[] interfaces() Included interfaces in this package.- Returns:
- array of interfaces found or empty array if none found
 
 - 
ordinaryClassesGroovyClassDoc[] ordinaryClasses() Included ordinary classes in this package.- Returns:
- array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
 
 - 
summaryjava.lang.String summary() The one-sentence summary for the package derived from the beginning of the description.- Returns:
- the summary
 
 - 
descriptionjava.lang.String description() Description of the package.- Returns:
- the description
 
 - 
nameWithDotsjava.lang.String nameWithDots() 
 - 
getRelativeRootPathjava.lang.String getRelativeRootPath() 
 
- 
 
-