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 Summary
FieldsModifier 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.SimpleGroovyDoc
ANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF, TRAIT_DEF -
Constructor Summary
ConstructorsConstructorDescriptionSimpleGroovyClassDoc(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
Modifier 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.SimpleGroovyAbstractableElementDoc
isAbstract, setAbstractMethods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyProgramElementDoc
addAnnotationRef, 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.SimpleGroovyDoc
calculateFirstSentence, 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyClassDoc
isAbstractMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoc
getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isRecord, name, setRawCommentTextMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedNameMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyType
toString
-
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
-
constructors
returns a sorted array of constructors- Specified by:
constructorsin interfaceGroovyClassDoc
-
add
-
getOuter
-
setOuter
-
isGroovy
public boolean isGroovy() -
setGroovy
public void setGroovy(boolean isgroovy) -
innerClasses
returns a sorted array of nested classes and interfaces- Specified by:
innerClassesin interfaceGroovyClassDoc
-
addNested
-
fields
returns a sorted array of fields- Specified by:
fieldsin interfaceGroovyClassDoc
-
add
-
properties
returns a sorted array of properties- Specified by:
propertiesin interfaceGroovyClassDoc
-
addProperty
-
enumConstants
returns a sorted array of enum constants- Specified by:
enumConstantsin interfaceGroovyClassDoc
-
addEnumConstant
-
methods
returns a sorted array of methods- Specified by:
methodsin interfaceGroovyClassDoc
-
add
-
getSuperClassName
-
setSuperClassName
-
superclass
- Specified by:
superclassin interfaceGroovyClassDoc
-
setSuperClass
-
getFullPathName
- Specified by:
getFullPathNamein interfaceGroovyClassDoc
-
setFullPathName
-
getRelativeRootPath
- Specified by:
getRelativeRootPathin interfaceGroovyClassDoc
-
getParentClasses
-
getParentInterfaces
-
getDocUrl
-
getDocUrl
-
getDocUrl
public static String getDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) -
constructors
- Specified by:
constructorsin interfaceGroovyClassDoc
-
definesSerializableFields
public boolean definesSerializableFields()- Specified by:
definesSerializableFieldsin interfaceGroovyClassDoc
-
fields
- Specified by:
fieldsin interfaceGroovyClassDoc
-
findClass
- Specified by:
findClassin interfaceGroovyClassDoc
-
importedClasses
- Specified by:
importedClassesin interfaceGroovyClassDoc
-
importedPackages
- Specified by:
importedPackagesin interfaceGroovyClassDoc
-
innerClasses
- Specified by:
innerClassesin interfaceGroovyClassDoc
-
interfaces
- Specified by:
interfacesin interfaceGroovyClassDoc
-
interfaceTypes
- Specified by:
interfaceTypesin interfaceGroovyClassDoc
-
isExternalizable
public boolean isExternalizable()- Specified by:
isExternalizablein interfaceGroovyClassDoc
-
isSerializable
public boolean isSerializable()- Specified by:
isSerializablein interfaceGroovyClassDoc
-
methods
- Specified by:
methodsin interfaceGroovyClassDoc
-
serializableFields
- Specified by:
serializableFieldsin interfaceGroovyClassDoc
-
serializationMethods
- Specified by:
serializationMethodsin interfaceGroovyClassDoc
-
subclassOf
- Specified by:
subclassOfin interfaceGroovyClassDoc
-
superclassType
- Specified by:
superclassTypein interfaceGroovyClassDoc
-
isPrimitive
public boolean isPrimitive()- Specified by:
isPrimitivein interfaceGroovyType
-
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 interfaceGroovyType
-
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 interfaceGroovyType
-
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 interfaceGroovyType
-
addInterfaceName
-
firstSentenceCommentText
- Specified by:
firstSentenceCommentTextin interfaceGroovyDoc- Overrides:
firstSentenceCommentTextin classSimpleGroovyDoc
-
commentText
- Specified by:
commentTextin interfaceGroovyDoc- Overrides:
commentTextin classSimpleGroovyDoc
-
replaceTags
-
replaceAllTags
-
replaceAllTags
public static String replaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc) -
replaceAllTagsCollated
-
encodeAngleBracketsInTagBody
Replaces angle brackets inside a tag.- Parameters:
text- GroovyDoc text to processregex- has to capture tag name in group 1 and tag body in group 2
-
encodeAngleBrackets
-
encodeSpecialSymbols
-
decodeSpecialSymbols
-
setNameWithTypeArgs
-
getNameWithTypeArgs
-