Class SimpleGroovyPackageDoc
- java.lang.Object
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyPackageDoc
 
 
- 
- All Implemented Interfaces:
- Comparable,- GroovyDoc,- GroovyPackageDoc
 
 public class SimpleGroovyPackageDoc extends SimpleGroovyDoc implements GroovyPackageDoc 
- 
- 
Field Summary- 
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF
 
- 
 - 
Constructor SummaryConstructors Constructor Description SimpleGroovyPackageDoc(String name)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description GroovyClassDoc[]allClasses()All included classes and interfaces in this package.GroovyClassDoc[]allClasses(boolean arg0)All classes and interfaces in this package optionally limited to just the included ones.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(String arg0)Find a class or interface within this package.StringgetRelativeRootPath()GroovyClassDoc[]interfaces()Included interfaces in this package.StringnameWithDots()GroovyClassDoc[]ordinaryClasses()Included ordinary classes in this package.voidputAll(Map<String,GroovyClassDoc> classes)voidsetDescription(String description)voidsetSummary(String summary)Stringsummary()The one-sentence summary for the package derived from the beginning of the description.- 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoccalculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isScript, isTrait, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, tokenType, toString
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 - 
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
 
- 
 
- 
- 
- 
Constructor Detail- 
SimpleGroovyPackageDocpublic SimpleGroovyPackageDoc(String name) 
 
- 
 - 
Method Detail- 
allClassespublic GroovyClassDoc[] allClasses() Description copied from interface:GroovyPackageDocAll included classes and interfaces in this package.- Specified by:
- allClassesin interface- GroovyPackageDoc
- Returns:
- array of classes and interfaces found or empty array if none found
 
 - 
setDescriptionpublic void setDescription(String description) 
 - 
setSummarypublic void setSummary(String summary) 
 - 
putAllpublic void putAll(Map<String,GroovyClassDoc> classes) 
 - 
nameWithDotspublic String nameWithDots() - Specified by:
- nameWithDotsin interface- GroovyPackageDoc
 
 - 
allClassespublic GroovyClassDoc[] allClasses(boolean arg0) Description copied from interface:GroovyPackageDocAll classes and interfaces in this package optionally limited to just the included ones.- Specified by:
- allClassesin interface- GroovyPackageDoc
- Parameters:
- arg0- 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
 
 - 
enumspublic GroovyClassDoc[] enums() Description copied from interface:GroovyPackageDocIncluded enum types in this package.- Specified by:
- enumsin interface- GroovyPackageDoc
- Returns:
- array of enum types found or empty array if none found
 
 - 
errorspublic GroovyClassDoc[] errors() Description copied from interface:GroovyPackageDocIncluded errors in this package.- Specified by:
- errorsin interface- GroovyPackageDoc
- Returns:
- array of errors found or empty array if none found
 
 - 
exceptionspublic GroovyClassDoc[] exceptions() Description copied from interface:GroovyPackageDocIncluded exceptions in this package.- Specified by:
- exceptionsin interface- GroovyPackageDoc
- Returns:
- array of exceptions found or empty array if none found
 
 - 
findClasspublic GroovyClassDoc findClass(String arg0) Description copied from interface:GroovyPackageDocFind a class or interface within this package.- Specified by:
- findClassin interface- GroovyPackageDoc
- Parameters:
- arg0- the name of the class to find
- Returns:
- ClassDoc of found class or interface, or null if not found
 
 - 
interfacespublic GroovyClassDoc[] interfaces() Description copied from interface:GroovyPackageDocIncluded interfaces in this package.- Specified by:
- interfacesin interface- GroovyPackageDoc
- Returns:
- array of interfaces found or empty array if none found
 
 - 
ordinaryClassespublic GroovyClassDoc[] ordinaryClasses() Description copied from interface:GroovyPackageDocIncluded ordinary classes in this package.- Specified by:
- ordinaryClassesin interface- GroovyPackageDoc
- Returns:
- array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
 
 - 
descriptionpublic String description() Description copied from interface:GroovyPackageDocDescription of the package.- Specified by:
- descriptionin interface- GroovyPackageDoc
- Returns:
- the description
 
 - 
summarypublic String summary() Description copied from interface:GroovyPackageDocThe one-sentence summary for the package derived from the beginning of the description.- Specified by:
- summaryin interface- GroovyPackageDoc
- Returns:
- the summary
 
 - 
getRelativeRootPathpublic String getRelativeRootPath() - Specified by:
- getRelativeRootPathin interface- GroovyPackageDoc
 
 
- 
 
-