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
Modifier and TypeFieldDescriptionstatic final Pattern
static final String
static final String
static final Pattern
static final Pattern
static final Pattern
static final Pattern
static final Pattern
static final Pattern
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
ANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF, TRAIT_DEF
-
Constructor Summary
ConstructorDescriptionSimpleGroovyClassDoc
(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 TypeMethodDescriptionboolean
add
(GroovyConstructorDoc constructor) boolean
add
(GroovyFieldDoc field) boolean
add
(GroovyMethodDoc method) boolean
addEnumConstant
(GroovyFieldDoc field) void
addInterfaceName
(String className) boolean
addNested
(GroovyClassDoc nestedClass) boolean
addProperty
(GroovyFieldDoc property) returns a sorted array of constructorsconstructors
(boolean filter) static String
decodeSpecialSymbols
(String text) boolean
static String
encodeAngleBrackets
(String text) static String
encodeAngleBracketsInTagBody
(String text, Pattern regex) Replaces angle brackets inside a tag.static String
encodeSpecialSymbols
(String text) returns a sorted array of enum constantsfields()
returns a sorted array of fieldsfields
(boolean filter) static String
getDocUrl
(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) boolean
boolean
isGroovy()
boolean
boolean
methods()
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 String
replaceAllTags
(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) void
setFullPathName
(String fullPathName) void
setGroovy
(boolean isgroovy) void
setNameWithTypeArgs
(String nameWithTypeArgs) void
setOuter
(GroovyClassDoc outer) void
void
setSuperClassName
(String className) The unqualified name of this type excluding any dimension or nesting information.boolean
subclassOf
(GroovyClassDoc gcd) typeName()
The unqualified name of this type excluding any dimension information.Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyAbstractableElementDoc
isAbstract, setAbstract
Methods 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, setStatic
Methods 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, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyClassDoc
isAbstract
Methods 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, setRawCommentText
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
Methods 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:
constructors
in 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:
innerClasses
in interfaceGroovyClassDoc
-
addNested
-
fields
returns a sorted array of fields- Specified by:
fields
in interfaceGroovyClassDoc
-
add
-
properties
returns a sorted array of properties- Specified by:
properties
in interfaceGroovyClassDoc
-
addProperty
-
enumConstants
returns a sorted array of enum constants- Specified by:
enumConstants
in interfaceGroovyClassDoc
-
addEnumConstant
-
methods
returns a sorted array of methods- Specified by:
methods
in interfaceGroovyClassDoc
-
add
-
getSuperClassName
-
setSuperClassName
-
superclass
- Specified by:
superclass
in interfaceGroovyClassDoc
-
setSuperClass
-
getFullPathName
- Specified by:
getFullPathName
in interfaceGroovyClassDoc
-
setFullPathName
-
getRelativeRootPath
- Specified by:
getRelativeRootPath
in 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:
constructors
in interfaceGroovyClassDoc
-
definesSerializableFields
public boolean definesSerializableFields()- Specified by:
definesSerializableFields
in interfaceGroovyClassDoc
-
fields
- Specified by:
fields
in interfaceGroovyClassDoc
-
findClass
- Specified by:
findClass
in interfaceGroovyClassDoc
-
importedClasses
- Specified by:
importedClasses
in interfaceGroovyClassDoc
-
importedPackages
- Specified by:
importedPackages
in interfaceGroovyClassDoc
-
innerClasses
- Specified by:
innerClasses
in interfaceGroovyClassDoc
-
interfaces
- Specified by:
interfaces
in interfaceGroovyClassDoc
-
interfaceTypes
- Specified by:
interfaceTypes
in interfaceGroovyClassDoc
-
isExternalizable
public boolean isExternalizable()- Specified by:
isExternalizable
in interfaceGroovyClassDoc
-
isSerializable
public boolean isSerializable()- Specified by:
isSerializable
in interfaceGroovyClassDoc
-
methods
- Specified by:
methods
in interfaceGroovyClassDoc
-
serializableFields
- Specified by:
serializableFields
in interfaceGroovyClassDoc
-
serializationMethods
- Specified by:
serializationMethods
in interfaceGroovyClassDoc
-
subclassOf
- Specified by:
subclassOf
in interfaceGroovyClassDoc
-
superclassType
- Specified by:
superclassType
in interfaceGroovyClassDoc
-
isPrimitive
public boolean isPrimitive()- Specified by:
isPrimitive
in interfaceGroovyType
-
qualifiedTypeName
Description copied from interface:GroovyType
The qualified name of this type excluding any dimension information. For example, a two-dimensional array of String returns "java.lang.String
".- Specified by:
qualifiedTypeName
in interfaceGroovyType
-
simpleTypeName
Description copied from interface:GroovyType
The unqualified name of this type excluding any dimension or nesting information. For example, the classOuter.Inner
returns "Inner
".- Specified by:
simpleTypeName
in interfaceGroovyType
-
typeName
Description copied from interface:GroovyType
The unqualified name of this type excluding any dimension information. For example, a two-dimensional array of String returns "String
".- Specified by:
typeName
in interfaceGroovyType
-
addInterfaceName
-
firstSentenceCommentText
- Specified by:
firstSentenceCommentText
in interfaceGroovyDoc
- Overrides:
firstSentenceCommentText
in classSimpleGroovyDoc
-
commentText
- Specified by:
commentText
in interfaceGroovyDoc
- Overrides:
commentText
in 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
-