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,- GroovyTokenTypes,- 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_REGEX- 
Fields inherited from interface org.codehaus.groovy.antlr.parser.GroovyTokenTypesABSTRACT, ANNOTATION, ANNOTATION_ARRAY_INIT, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ANNOTATION_MEMBER_VALUE_PAIR, ANNOTATIONS, ARRAY_DECLARATOR, ASSIGN, AT, BAND, BAND_ASSIGN, BIG_SUFFIX, BLOCK, BNOT, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, CASE_GROUP, CLASS_DEF, CLOSABLE_BLOCK, CLOSABLE_BLOCK_OP, CLOSURE_LIST, COLON, COMMA, COMPARE_TO, CTOR_CALL, CTOR_IDENT, DEC, DIGIT, DIGITS_WITH_UNDERSCORE, DIGITS_WITH_UNDERSCORE_OPT, DIV, DIV_ASSIGN, DOLLAR, DOLLAR_REGEXP_CTOR_END, DOLLAR_REGEXP_LITERAL, DOLLAR_REGEXP_SYMBOL, DOT, DYNAMIC_MEMBER, ELIST, ELVIS_OPERATOR, EMPTY_STAT, ENUM_CONSTANT_DEF, ENUM_DEF, EOF, EQUAL, ESC, ESCAPED_DOLLAR, ESCAPED_SLASH, EXPONENT, EXPR, EXTENDS_CLAUSE, FINAL, FLOAT_SUFFIX, FOR_CONDITION, FOR_EACH_CLAUSE, FOR_IN_ITERABLE, FOR_INIT, FOR_ITERATOR, GE, GT, HEX_DIGIT, IDENT, IDENTICAL, IMPLEMENTS_CLAUSE, IMPLICIT_PARAMETERS, IMPORT, INC, INDEX_OP, INSTANCE_INIT, INTERFACE_DEF, LABELED_ARG, LABELED_STAT, LAND, LBRACK, LCURLY, LE, LETTER, LIST_CONSTRUCTOR, LITERAL_as, LITERAL_assert, LITERAL_boolean, LITERAL_break, LITERAL_byte, LITERAL_case, LITERAL_catch, LITERAL_char, LITERAL_class, LITERAL_continue, LITERAL_def, LITERAL_default, LITERAL_double, LITERAL_else, LITERAL_enum, LITERAL_extends, LITERAL_false, LITERAL_finally, LITERAL_float, LITERAL_for, LITERAL_if, LITERAL_implements, LITERAL_import, LITERAL_in, LITERAL_instanceof, LITERAL_int, LITERAL_interface, LITERAL_long, LITERAL_native, LITERAL_new, LITERAL_null, LITERAL_package, LITERAL_private, LITERAL_protected, LITERAL_public, LITERAL_return, LITERAL_short, LITERAL_static, LITERAL_super, LITERAL_switch, LITERAL_synchronized, LITERAL_this, LITERAL_threadsafe, LITERAL_throw, LITERAL_throws, LITERAL_trait, LITERAL_transient, LITERAL_true, LITERAL_try, LITERAL_void, LITERAL_volatile, LITERAL_while, LNOT, LOR, LPAREN, LT, MAP_CONSTRUCTOR, MEMBER_POINTER, METHOD_CALL, METHOD_DEF, MINUS, MINUS_ASSIGN, ML_COMMENT, MOD, MOD_ASSIGN, MODIFIERS, MULTICATCH, MULTICATCH_TYPES, NLS, NOT_EQUAL, NOT_IDENTICAL, NULL_TREE_LOOKAHEAD, NUM_BIG_DECIMAL, NUM_BIG_INT, NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG, OBJBLOCK, ONE_NL, OPTIONAL_DOT, PACKAGE_DEF, PARAMETER_DEF, PARAMETERS, PLUS, PLUS_ASSIGN, POST_DEC, POST_INC, QUESTION, RANGE_EXCLUSIVE, RANGE_INCLUSIVE, RBRACK, RCURLY, REGEX_FIND, REGEX_MATCH, REGEXP_CTOR_END, REGEXP_LITERAL, REGEXP_SYMBOL, RPAREN, SELECT_SLOT, SEMI, SH_COMMENT, SL, SL_ASSIGN, SL_COMMENT, SLIST, SPREAD_ARG, SPREAD_DOT, SPREAD_MAP_ARG, SR, SR_ASSIGN, STAR, STAR_ASSIGN, STAR_STAR, STAR_STAR_ASSIGN, STATIC_IMPORT, STATIC_INIT, STRICTFP, STRING_CH, STRING_CONSTRUCTOR, STRING_CTOR_END, STRING_CTOR_MIDDLE, STRING_CTOR_START, STRING_LITERAL, STRING_NL, SUPER_CTOR_CALL, TRAIT_DEF, TRIPLE_DOT, TYPE, TYPE_ARGUMENT, TYPE_ARGUMENTS, TYPE_LOWER_BOUNDS, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_UPPER_BOUNDS, TYPECAST, UNARY_MINUS, UNARY_PLUS, UNUSED_CONST, UNUSED_DO, UNUSED_GOTO, VARIABLE_DEF, VARIABLE_PARAMETER_DEF, VOCAB, WILDCARD_TYPE, WS
 
- 
 - 
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 SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier 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, 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 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 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 Detail- 
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 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 java.lang.String getSuperClassName() 
 - 
setSuperClassNamepublic void setSuperClassName(java.lang.String className) 
 - 
superclasspublic GroovyClassDoc superclass() - Specified by:
- superclassin interface- GroovyClassDoc
 
 - 
setSuperClasspublic void setSuperClass(GroovyClassDoc doc) 
 - 
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
 
 - 
getParentClassespublic java.util.List<GroovyClassDoc> getParentClasses() 
 - 
getParentInterfacespublic java.util.Set<GroovyClassDoc> 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)
 - 
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(java.lang.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 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() 
 
- 
 
-