Class SimpleGroovyClassDoc
- java.lang.Object
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyProgramElementDoc
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyAbstractableElementDoc
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc
 
 
 
 
- 
- All Implemented Interfaces:
- Comparable,- GroovyClassDoc,- GroovyDoc,- GroovyProgramElementDoc,- GroovyType
 
 public class SimpleGroovyClassDoc extends SimpleGroovyAbstractableElementDoc implements GroovyClassDoc 
- 
- 
Field SummaryFields Modifier and Type Field Description static PatternCODE_REGEXstatic StringDOCROOT_PATTERNstatic StringDOCROOT_PATTERN2static PatternLINK_REGEXstatic PatternLITERAL_REGEXstatic PatternNAME_ARGS_REGEXstatic PatternREF_LABEL_REGEXstatic PatternSPLIT_ARGS_REGEXstatic PatternTAG_REGEX- 
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF
 
- 
 - 
Constructor SummaryConstructors Constructor Description SimpleGroovyClassDoc(List<String> importedClassesAndPackages, String name)SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name)SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name, List<LinkArgument> links)
 - 
Method Summary- 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyAbstractableElementDocisAbstract, setAbstract
 - 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyProgramElementDocaddAnnotationRef, annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName, setContainingPackage, setFinal, setPackagePrivate, setPrivate, setProtected, setPublic, setStatic
 - 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoccalculateFirstSentence, compareTo, 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.GroovyClassDocisAbstract
 - 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyDocgetRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
 - 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyProgramElementDocannotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
 - 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyTypetoString
 
- 
 
- 
- 
- 
Field Detail- 
TAG_REGEXpublic static final Pattern TAG_REGEX 
 - 
DOCROOT_PATTERN2public static final String DOCROOT_PATTERN2 - See Also:
- Constant Field Values
 
 - 
DOCROOT_PATTERNpublic static final String DOCROOT_PATTERN - See Also:
- Constant Field Values
 
 - 
LINK_REGEXpublic static final Pattern LINK_REGEX 
 - 
LITERAL_REGEXpublic static final Pattern LITERAL_REGEX 
 - 
CODE_REGEXpublic static final Pattern CODE_REGEX 
 - 
REF_LABEL_REGEXpublic static final Pattern REF_LABEL_REGEX 
 - 
NAME_ARGS_REGEXpublic static final Pattern NAME_ARGS_REGEX 
 - 
SPLIT_ARGS_REGEXpublic static final Pattern SPLIT_ARGS_REGEX 
 
- 
 - 
Constructor Detail- 
SimpleGroovyClassDocpublic SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name, List<LinkArgument> links) 
 - 
SimpleGroovyClassDocpublic SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name) 
 
- 
 - 
Method Detail- 
constructorspublic GroovyConstructorDoc[] constructors() returns a sorted array of constructors- Specified by:
- constructorsin interface- GroovyClassDoc
 
 - 
addpublic boolean add(GroovyConstructorDoc constructor) 
 - 
getOuterpublic GroovyClassDoc getOuter() 
 - 
setOuterpublic void setOuter(GroovyClassDoc outer) 
 - 
isGroovypublic boolean isGroovy() 
 - 
setGroovypublic void setGroovy(boolean isgroovy) 
 - 
innerClassespublic GroovyClassDoc[] innerClasses() returns a sorted array of nested classes and interfaces- Specified by:
- innerClassesin interface- GroovyClassDoc
 
 - 
addNestedpublic boolean addNested(GroovyClassDoc nestedClass) 
 - 
fieldspublic GroovyFieldDoc[] fields() returns a sorted array of fields- Specified by:
- fieldsin interface- GroovyClassDoc
 
 - 
addpublic boolean add(GroovyFieldDoc field) 
 - 
propertiespublic GroovyFieldDoc[] properties() returns a sorted array of properties- Specified by:
- propertiesin interface- GroovyClassDoc
 
 - 
addPropertypublic boolean addProperty(GroovyFieldDoc property) 
 - 
enumConstantspublic GroovyFieldDoc[] enumConstants() returns a sorted array of enum constants- Specified by:
- enumConstantsin interface- GroovyClassDoc
 
 - 
addEnumConstantpublic boolean addEnumConstant(GroovyFieldDoc field) 
 - 
methodspublic GroovyMethodDoc[] methods() returns a sorted array of methods- Specified by:
- methodsin interface- GroovyClassDoc
 
 - 
addpublic boolean add(GroovyMethodDoc method) 
 - 
getSuperClassNamepublic String getSuperClassName() 
 - 
setSuperClassNamepublic void setSuperClassName(String className) 
 - 
superclasspublic GroovyClassDoc superclass() - Specified by:
- superclassin interface- GroovyClassDoc
 
 - 
setSuperClasspublic void setSuperClass(GroovyClassDoc doc) 
 - 
getFullPathNamepublic String getFullPathName() - Specified by:
- getFullPathNamein interface- GroovyClassDoc
 
 - 
setFullPathNamepublic void setFullPathName(String fullPathName) 
 - 
getRelativeRootPathpublic String getRelativeRootPath() - Specified by:
- getRelativeRootPathin interface- GroovyClassDoc
 
 - 
getParentClassespublic List<GroovyClassDoc> getParentClasses() 
 - 
getParentInterfacespublic Set<GroovyClassDoc> getParentInterfaces() 
 - 
getDocUrlpublic static String getDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) 
 - 
constructorspublic GroovyConstructorDoc[] constructors(boolean filter) - Specified by:
- constructorsin interface- GroovyClassDoc
 
 - 
definesSerializableFieldspublic boolean definesSerializableFields() - Specified by:
- definesSerializableFieldsin interface- GroovyClassDoc
 
 - 
fieldspublic GroovyFieldDoc[] fields(boolean filter) - Specified by:
- fieldsin interface- GroovyClassDoc
 
 - 
findClasspublic GroovyClassDoc findClass(String className) - Specified by:
- findClassin interface- GroovyClassDoc
 
 - 
importedClassespublic GroovyClassDoc[] importedClasses() - Specified by:
- importedClassesin interface- GroovyClassDoc
 
 - 
importedPackagespublic GroovyPackageDoc[] importedPackages() - Specified by:
- importedPackagesin interface- GroovyClassDoc
 
 - 
innerClassespublic GroovyClassDoc[] innerClasses(boolean filter) - Specified by:
- innerClassesin interface- GroovyClassDoc
 
 - 
interfacespublic GroovyClassDoc[] interfaces() - Specified by:
- interfacesin interface- GroovyClassDoc
 
 - 
interfaceTypespublic GroovyType[] interfaceTypes() - Specified by:
- interfaceTypesin interface- GroovyClassDoc
 
 - 
isExternalizablepublic boolean isExternalizable() - Specified by:
- isExternalizablein interface- GroovyClassDoc
 
 - 
isSerializablepublic boolean isSerializable() - Specified by:
- isSerializablein interface- GroovyClassDoc
 
 - 
methodspublic GroovyMethodDoc[] methods(boolean filter) - Specified by:
- methodsin interface- GroovyClassDoc
 
 - 
serializableFieldspublic GroovyFieldDoc[] serializableFields() - Specified by:
- serializableFieldsin interface- GroovyClassDoc
 
 - 
serializationMethodspublic GroovyMethodDoc[] serializationMethods() - Specified by:
- serializationMethodsin interface- GroovyClassDoc
 
 - 
subclassOfpublic boolean subclassOf(GroovyClassDoc gcd) - Specified by:
- subclassOfin interface- GroovyClassDoc
 
 - 
superclassTypepublic GroovyType superclassType() - Specified by:
- superclassTypein interface- GroovyClassDoc
 
 - 
isPrimitivepublic boolean isPrimitive() - Specified by:
- isPrimitivein interface- GroovyType
 
 - 
qualifiedTypeNamepublic String qualifiedTypeName() Description copied from interface:GroovyTypeThe qualified name of this type excluding any dimension information. For example, a two dimensional array of String returns "java.lang.String".- Specified by:
- qualifiedTypeNamein interface- GroovyType
 
 - 
simpleTypeNamepublic String simpleTypeName() Description copied from interface:GroovyTypeThe unqualified name of this type excluding any dimension or nesting information. For example, the classOuter.Innerreturns "Inner".- Specified by:
- simpleTypeNamein interface- GroovyType
 
 - 
typeNamepublic String typeName() Description copied from interface:GroovyTypeThe unqualified name of this type excluding any dimension information. For example, a two dimensional array of String returns "String".- Specified by:
- typeNamein interface- GroovyType
 
 - 
addInterfaceNamepublic void addInterfaceName(String className) 
 - 
firstSentenceCommentTextpublic String firstSentenceCommentText() - Specified by:
- firstSentenceCommentTextin interface- GroovyDoc
- Overrides:
- firstSentenceCommentTextin class- SimpleGroovyDoc
 
 - 
commentTextpublic String commentText() - Specified by:
- commentTextin interface- GroovyDoc
- Overrides:
- commentTextin class- SimpleGroovyDoc
 
 - 
replaceAllTagspublic static String replaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) 
 - 
replaceAllTagsCollatedpublic String replaceAllTagsCollated(String self, String preKey, String postKey, String valueSeparator, String postValues, Pattern regex) 
 - 
encodeAngleBracketsInTagBodypublic static String encodeAngleBracketsInTagBody(String text, Pattern regex) Replaces angle brackets inside a tag.- Parameters:
- text- GroovyDoc text to process
- regex- has to capture tag name in group 1 and tag body in group 2
 
 - 
setNameWithTypeArgspublic void setNameWithTypeArgs(String nameWithTypeArgs) 
 - 
getNameWithTypeArgspublic String getNameWithTypeArgs() 
 
- 
 
-