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<GroovyDoc>,- GroovyClassDoc,- GroovyDoc,- GroovyProgramElementDoc,- GroovyType
public class SimpleGroovyClassDoc
extends SimpleGroovyAbstractableElementDoc
implements GroovyClassDoc
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final Patternstatic final Stringstatic final Stringstatic final Patternstatic final Patternstatic final Patternstatic final Patternstatic final Patternstatic final PatternFields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF, TRAIT_DEF
- 
Constructor SummaryConstructorsConstructorDescriptionSimpleGroovyClassDoc(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 SummaryModifier and TypeMethodDescriptionbooleanadd(GroovyConstructorDoc constructor) booleanadd(GroovyFieldDoc field) booleanadd(GroovyMethodDoc method) booleanaddEnumConstant(GroovyFieldDoc field) voidaddInterfaceName(String className) booleanaddNested(GroovyClassDoc nestedClass) booleanaddProperty(GroovyFieldDoc property) returns a sorted array of constructorsconstructors(boolean filter) static StringdecodeSpecialSymbols(String text) booleanstatic StringencodeAngleBrackets(String text) static StringencodeAngleBracketsInTagBody(String text, Pattern regex) Replaces angle brackets inside a tag.static StringencodeSpecialSymbols(String text) returns a sorted array of enum constantsfields()returns a sorted array of fieldsfields(boolean filter) static StringgetDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) getOuter()returns a sorted array of nested classes and interfacesinnerClasses(boolean filter) booleanbooleanisGroovy()booleanbooleanmethods()returns a sorted array of methodsmethods(boolean filter) returns a sorted array of propertiesThe qualified name of this type excluding any dimension information.replaceAllTags(String self, String s1, String s2, Pattern regex) static StringreplaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) replaceAllTagsCollated(String self, String preKey, String postKey, String valueSeparator, String postValues, Pattern regex) replaceTags(String comment) voidsetFullPathName(String fullPathName) voidsetGroovy(boolean isgroovy) voidsetNameWithTypeArgs(String nameWithTypeArgs) voidsetOuter(GroovyClassDoc outer) voidvoidsetSuperClassName(String className) The unqualified name of this type excluding any dimension or nesting information.booleansubclassOf(GroovyClassDoc gcd) typeName()The unqualified name of this type excluding any dimension information.Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyAbstractableElementDocisAbstract, setAbstractMethods 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, setStaticMethods 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, isRecord, isScript, isTrait, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, tokenType, toStringMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.ComparablecompareToMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyClassDocisAbstractMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyDocgetRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isRecord, name, setRawCommentTextMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyProgramElementDocannotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedNameMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyTypetoString
- 
Field Details- 
TAG_REGEX
- 
DOCROOT_PATTERN2- See Also:
 
- 
DOCROOT_PATTERN- See Also:
 
- 
LINK_REGEX
- 
LITERAL_REGEX
- 
CODE_REGEX
- 
REF_LABEL_REGEX
- 
NAME_ARGS_REGEX
- 
SPLIT_ARGS_REGEX
 
- 
- 
Constructor Details- 
SimpleGroovyClassDoc
- 
SimpleGroovyClassDoc
- 
SimpleGroovyClassDoc
 
- 
- 
Method Details- 
constructorsreturns a sorted array of constructors- Specified by:
- constructorsin interface- GroovyClassDoc
 
- 
add
- 
getOuter
- 
setOuter
- 
isGroovypublic boolean isGroovy()
- 
setGroovypublic void setGroovy(boolean isgroovy) 
- 
innerClassesreturns a sorted array of nested classes and interfaces- Specified by:
- innerClassesin interface- GroovyClassDoc
 
- 
addNested
- 
fieldsreturns a sorted array of fields- Specified by:
- fieldsin interface- GroovyClassDoc
 
- 
add
- 
propertiesreturns a sorted array of properties- Specified by:
- propertiesin interface- GroovyClassDoc
 
- 
addProperty
- 
enumConstantsreturns a sorted array of enum constants- Specified by:
- enumConstantsin interface- GroovyClassDoc
 
- 
addEnumConstant
- 
methodsreturns a sorted array of methods- Specified by:
- methodsin interface- GroovyClassDoc
 
- 
add
- 
getSuperClassName
- 
setSuperClassName
- 
superclass- Specified by:
- superclassin interface- GroovyClassDoc
 
- 
setSuperClass
- 
getFullPathName- Specified by:
- getFullPathNamein interface- GroovyClassDoc
 
- 
setFullPathName
- 
getRelativeRootPath- Specified by:
- getRelativeRootPathin interface- GroovyClassDoc
 
- 
getParentClasses
- 
getParentInterfaces
- 
getDocUrl
- 
getDocUrl
- 
getDocUrlpublic static String getDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) 
- 
constructors- Specified by:
- constructorsin interface- GroovyClassDoc
 
- 
definesSerializableFieldspublic boolean definesSerializableFields()- Specified by:
- definesSerializableFieldsin interface- GroovyClassDoc
 
- 
fields- Specified by:
- fieldsin interface- GroovyClassDoc
 
- 
findClass- Specified by:
- findClassin interface- GroovyClassDoc
 
- 
importedClasses- Specified by:
- importedClassesin interface- GroovyClassDoc
 
- 
importedPackages- Specified by:
- importedPackagesin interface- GroovyClassDoc
 
- 
innerClasses- Specified by:
- innerClassesin interface- GroovyClassDoc
 
- 
interfaces- Specified by:
- interfacesin interface- GroovyClassDoc
 
- 
interfaceTypes- Specified by:
- interfaceTypesin interface- GroovyClassDoc
 
- 
isExternalizablepublic boolean isExternalizable()- Specified by:
- isExternalizablein interface- GroovyClassDoc
 
- 
isSerializablepublic boolean isSerializable()- Specified by:
- isSerializablein interface- GroovyClassDoc
 
- 
methods- Specified by:
- methodsin interface- GroovyClassDoc
 
- 
serializableFields- Specified by:
- serializableFieldsin interface- GroovyClassDoc
 
- 
serializationMethods- Specified by:
- serializationMethodsin interface- GroovyClassDoc
 
- 
subclassOf- Specified by:
- subclassOfin interface- GroovyClassDoc
 
- 
superclassType- Specified by:
- superclassTypein interface- GroovyClassDoc
 
- 
isPrimitivepublic boolean isPrimitive()- Specified by:
- isPrimitivein interface- GroovyType
 
- 
qualifiedTypeNameDescription 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
 
- 
simpleTypeNameDescription 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
 
- 
typeNameDescription 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
 
- 
addInterfaceName
- 
firstSentenceCommentText- Specified by:
- firstSentenceCommentTextin interface- GroovyDoc
- Overrides:
- firstSentenceCommentTextin class- SimpleGroovyDoc
 
- 
commentText- Specified by:
- commentTextin interface- GroovyDoc
- Overrides:
- commentTextin class- SimpleGroovyDoc
 
- 
replaceTags
- 
replaceAllTags
- 
replaceAllTagspublic static String replaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) 
- 
replaceAllTagsCollated
- 
encodeAngleBracketsInTagBodyReplaces 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
 
- 
encodeAngleBrackets
- 
encodeSpecialSymbols
- 
decodeSpecialSymbols
- 
setNameWithTypeArgs
- 
getNameWithTypeArgs
 
-