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:
- java.lang.Comparable,- GroovyClassDoc,- GroovyDoc,- GroovyProgramElementDoc,- GroovyType
public class SimpleGroovyClassDoc extends SimpleGroovyAbstractableElementDoc implements GroovyClassDoc
- 
Field SummaryFields Modifier and Type Field Description static java.util.regex.PatternCODE_REGEXstatic java.lang.StringDOCROOT_PATTERNstatic java.lang.StringDOCROOT_PATTERN2static java.util.regex.PatternLINK_REGEXstatic java.util.regex.PatternLITERAL_REGEXstatic java.util.regex.PatternNAME_ARGS_REGEXstatic java.util.regex.PatternREF_LABEL_REGEXstatic java.util.regex.PatternSPLIT_ARGS_REGEXstatic java.util.regex.PatternTAG_REGEXFields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF
- 
Constructor SummaryConstructors Constructor Description SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.lang.String name)SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.util.Map<java.lang.String,java.lang.String> aliases, java.lang.String name)SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.util.Map<java.lang.String,java.lang.String> aliases, java.lang.String name, java.util.List<LinkArgument> links)
- 
Method SummaryModifier and Type Method Description booleanadd(GroovyConstructorDoc constructor)booleanadd(GroovyFieldDoc field)booleanadd(GroovyMethodDoc method)booleanaddEnumConstant(GroovyFieldDoc field)voidaddInterfaceName(java.lang.String className)booleanaddNested(GroovyClassDoc nestedClass)booleanaddProperty(GroovyFieldDoc property)java.lang.StringcommentText()GroovyConstructorDoc[]constructors()returns a sorted array of constructorsGroovyConstructorDoc[]constructors(boolean filter)static java.lang.StringdecodeSpecialSymbols(java.lang.String text)booleandefinesSerializableFields()static java.lang.StringencodeAngleBrackets(java.lang.String text)static java.lang.StringencodeAngleBracketsInTagBody(java.lang.String text, java.util.regex.Pattern regex)Replaces angle brackets inside a tag.static java.lang.StringencodeSpecialSymbols(java.lang.String text)GroovyFieldDoc[]enumConstants()returns a sorted array of enum constantsGroovyFieldDoc[]fields()returns a sorted array of fieldsGroovyFieldDoc[]fields(boolean filter)GroovyClassDocfindClass(java.lang.String className)java.lang.StringfirstSentenceCommentText()java.lang.StringgetDocUrl(java.lang.String type)java.lang.StringgetDocUrl(java.lang.String type, boolean full)static java.lang.StringgetDocUrl(java.lang.String type, boolean full, java.util.List<LinkArgument> links, java.lang.String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)java.lang.StringgetFullPathName()java.lang.StringgetNameWithTypeArgs()GroovyClassDocgetOuter()java.util.List<GroovyClassDoc>getParentClasses()java.util.Set<GroovyClassDoc>getParentInterfaces()java.lang.StringgetRelativeRootPath()java.lang.StringgetSuperClassName()GroovyClassDoc[]importedClasses()GroovyPackageDoc[]importedPackages()GroovyClassDoc[]innerClasses()returns a sorted array of nested classes and interfacesGroovyClassDoc[]innerClasses(boolean filter)GroovyClassDoc[]interfaces()GroovyType[]interfaceTypes()booleanisExternalizable()booleanisGroovy()booleanisPrimitive()booleanisSerializable()GroovyMethodDoc[]methods()returns a sorted array of methodsGroovyMethodDoc[]methods(boolean filter)GroovyFieldDoc[]properties()returns a sorted array of propertiesjava.lang.StringqualifiedTypeName()The qualified name of this type excluding any dimension information.java.lang.StringreplaceAllTags(java.lang.String self, java.lang.String s1, java.lang.String s2, java.util.regex.Pattern regex)static java.lang.StringreplaceAllTags(java.lang.String self, java.lang.String s1, java.lang.String s2, java.util.regex.Pattern regex, java.util.List<LinkArgument> links, java.lang.String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)java.lang.StringreplaceAllTagsCollated(java.lang.String self, java.lang.String preKey, java.lang.String postKey, java.lang.String valueSeparator, java.lang.String postValues, java.util.regex.Pattern regex)java.lang.StringreplaceTags(java.lang.String comment)GroovyFieldDoc[]serializableFields()GroovyMethodDoc[]serializationMethods()voidsetFullPathName(java.lang.String fullPathName)voidsetGroovy(boolean isgroovy)voidsetNameWithTypeArgs(java.lang.String nameWithTypeArgs)voidsetOuter(GroovyClassDoc outer)voidsetSuperClass(GroovyClassDoc doc)voidsetSuperClassName(java.lang.String className)java.lang.StringsimpleTypeName()The unqualified name of this type excluding any dimension or nesting information.booleansubclassOf(GroovyClassDoc gcd)GroovyClassDocsuperclass()GroovyTypesuperclassType()java.lang.StringtypeName()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, 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, 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_REGEXpublic static final java.util.regex.Pattern TAG_REGEX
- 
DOCROOT_PATTERN2public static final java.lang.String DOCROOT_PATTERN2- See Also:
- Constant Field Values
 
- 
DOCROOT_PATTERNpublic static final java.lang.String DOCROOT_PATTERN- See Also:
- Constant Field Values
 
- 
LINK_REGEXpublic static final java.util.regex.Pattern LINK_REGEX
- 
LITERAL_REGEXpublic static final java.util.regex.Pattern LITERAL_REGEX
- 
CODE_REGEXpublic static final java.util.regex.Pattern CODE_REGEX
- 
REF_LABEL_REGEXpublic static final java.util.regex.Pattern REF_LABEL_REGEX
- 
NAME_ARGS_REGEXpublic static final java.util.regex.Pattern NAME_ARGS_REGEX
- 
SPLIT_ARGS_REGEXpublic static final java.util.regex.Pattern SPLIT_ARGS_REGEX
 
- 
- 
Constructor Details- 
SimpleGroovyClassDocpublic SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.util.Map<java.lang.String,java.lang.String> aliases, java.lang.String name, java.util.List<LinkArgument> links)
- 
SimpleGroovyClassDocpublic SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.util.Map<java.lang.String,java.lang.String> aliases, java.lang.String name)
- 
SimpleGroovyClassDocpublic SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.lang.String name)
 
- 
- 
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
- 
getSuperClassNamepublic java.lang.String getSuperClassName()
- 
setSuperClassNamepublic void setSuperClassName(java.lang.String className)
- 
superclass- Specified by:
- superclassin interface- GroovyClassDoc
 
- 
setSuperClass
- 
getFullPathNamepublic java.lang.String getFullPathName()- Specified by:
- getFullPathNamein interface- GroovyClassDoc
 
- 
setFullPathNamepublic void setFullPathName(java.lang.String fullPathName)
- 
getRelativeRootPathpublic java.lang.String getRelativeRootPath()- Specified by:
- getRelativeRootPathin interface- GroovyClassDoc
 
- 
getParentClasses
- 
getParentInterfaces
- 
getDocUrlpublic java.lang.String getDocUrl(java.lang.String type)
- 
getDocUrlpublic java.lang.String getDocUrl(java.lang.String type, boolean full)
- 
getDocUrlpublic static java.lang.String getDocUrl(java.lang.String type, boolean full, java.util.List<LinkArgument> links, java.lang.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
 
- 
qualifiedTypeNamepublic java.lang.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 java.lang.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 java.lang.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(java.lang.String className)
- 
firstSentenceCommentTextpublic java.lang.String firstSentenceCommentText()- Specified by:
- firstSentenceCommentTextin interface- GroovyDoc
- Overrides:
- firstSentenceCommentTextin class- SimpleGroovyDoc
 
- 
commentTextpublic java.lang.String commentText()- Specified by:
- commentTextin interface- GroovyDoc
- Overrides:
- commentTextin class- SimpleGroovyDoc
 
- 
replaceTagspublic java.lang.String replaceTags(java.lang.String comment)
- 
replaceAllTagspublic java.lang.String replaceAllTags(java.lang.String self, java.lang.String s1, java.lang.String s2, java.util.regex.Pattern regex)
- 
replaceAllTagspublic static java.lang.String replaceAllTags(java.lang.String self, java.lang.String s1, java.lang.String s2, java.util.regex.Pattern regex, java.util.List<LinkArgument> links, java.lang.String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
- 
replaceAllTagsCollatedpublic java.lang.String replaceAllTagsCollated(java.lang.String self, java.lang.String preKey, java.lang.String postKey, java.lang.String valueSeparator, java.lang.String postValues, java.util.regex.Pattern regex)
- 
encodeAngleBracketsInTagBodypublic static java.lang.String encodeAngleBracketsInTagBody(java.lang.String text, java.util.regex.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
 
- 
encodeAngleBracketspublic static java.lang.String encodeAngleBrackets(java.lang.String text)
- 
encodeSpecialSymbolspublic static java.lang.String encodeSpecialSymbols(java.lang.String text)
- 
decodeSpecialSymbolspublic static java.lang.String decodeSpecialSymbols(java.lang.String text)
- 
setNameWithTypeArgspublic void setNameWithTypeArgs(java.lang.String nameWithTypeArgs)
- 
getNameWithTypeArgspublic java.lang.String getNameWithTypeArgs()
 
-