public class SimpleGroovyClassDoc extends SimpleGroovyAbstractableElementDoc implements GroovyClassDoc
| Modifier and Type | Field and Description |
|---|---|
static Pattern |
CODE_REGEX |
static String |
DOCROOT_PATTERN |
static String |
DOCROOT_PATTERN2 |
static Pattern |
LINK_REGEX |
static Pattern |
LITERAL_REGEX |
static Pattern |
NAME_ARGS_REGEX |
static Pattern |
REF_LABEL_REGEX |
static Pattern |
SPLIT_ARGS_REGEX |
static Pattern |
TAG_REGEX |
ABSTRACT, 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 and Description |
|---|
SimpleGroovyClassDoc(List<String> importedClassesAndPackages,
Map<String,String> aliases,
String name) |
SimpleGroovyClassDoc(List<String> importedClassesAndPackages,
Map<String,String> aliases,
String name,
List<LinkArgument> links) |
SimpleGroovyClassDoc(List<String> importedClassesAndPackages,
String name) |
isAbstract, setAbstractaddAnnotationRef, annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName, setContainingPackage, setFinal, setPackagePrivate, setPrivate, setProtected, setPublic, setStaticcalculateFirstSentence, 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, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitisAbstracttoStringannotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedNamegetRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentTextcompareTopublic static final Pattern TAG_REGEX
public static final String DOCROOT_PATTERN2
public static final String DOCROOT_PATTERN
public static final Pattern LINK_REGEX
public static final Pattern LITERAL_REGEX
public static final Pattern CODE_REGEX
public static final Pattern REF_LABEL_REGEX
public static final Pattern NAME_ARGS_REGEX
public static final Pattern SPLIT_ARGS_REGEX
public SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name, List<LinkArgument> links)
public SimpleGroovyClassDoc(List<String> importedClassesAndPackages, Map<String,String> aliases, String name)
public GroovyConstructorDoc[] constructors()
constructors in interface GroovyClassDocpublic boolean add(GroovyConstructorDoc constructor)
public GroovyClassDoc getOuter()
public void setOuter(GroovyClassDoc outer)
public boolean isGroovy()
public void setGroovy(boolean isgroovy)
public GroovyClassDoc[] innerClasses()
innerClasses in interface GroovyClassDocpublic boolean addNested(GroovyClassDoc nestedClass)
public GroovyFieldDoc[] fields()
fields in interface GroovyClassDocpublic boolean add(GroovyFieldDoc field)
public GroovyFieldDoc[] properties()
properties in interface GroovyClassDocpublic boolean addProperty(GroovyFieldDoc property)
public GroovyFieldDoc[] enumConstants()
enumConstants in interface GroovyClassDocpublic boolean addEnumConstant(GroovyFieldDoc field)
public GroovyMethodDoc[] methods()
methods in interface GroovyClassDocpublic boolean add(GroovyMethodDoc method)
public String getSuperClassName()
public void setSuperClassName(String className)
public GroovyClassDoc superclass()
superclass in interface GroovyClassDocpublic void setSuperClass(GroovyClassDoc doc)
public String getFullPathName()
getFullPathName in interface GroovyClassDocpublic void setFullPathName(String fullPathName)
public String getRelativeRootPath()
getRelativeRootPath in interface GroovyClassDocpublic List<GroovyClassDoc> getParentClasses()
public Set<GroovyClassDoc> getParentInterfaces()
public static String getDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
public GroovyConstructorDoc[] constructors(boolean filter)
constructors in interface GroovyClassDocpublic boolean definesSerializableFields()
definesSerializableFields in interface GroovyClassDocpublic GroovyFieldDoc[] fields(boolean filter)
fields in interface GroovyClassDocpublic GroovyClassDoc findClass(String className)
findClass in interface GroovyClassDocpublic GroovyClassDoc[] importedClasses()
importedClasses in interface GroovyClassDocpublic GroovyPackageDoc[] importedPackages()
importedPackages in interface GroovyClassDocpublic GroovyClassDoc[] innerClasses(boolean filter)
innerClasses in interface GroovyClassDocpublic GroovyClassDoc[] interfaces()
interfaces in interface GroovyClassDocpublic GroovyType[] interfaceTypes()
interfaceTypes in interface GroovyClassDocpublic boolean isExternalizable()
isExternalizable in interface GroovyClassDocpublic boolean isSerializable()
isSerializable in interface GroovyClassDocpublic GroovyMethodDoc[] methods(boolean filter)
methods in interface GroovyClassDocpublic GroovyFieldDoc[] serializableFields()
serializableFields in interface GroovyClassDocpublic GroovyMethodDoc[] serializationMethods()
serializationMethods in interface GroovyClassDocpublic boolean subclassOf(GroovyClassDoc gcd)
subclassOf in interface GroovyClassDocpublic GroovyType superclassType()
superclassType in interface GroovyClassDocpublic boolean isPrimitive()
isPrimitive in interface GroovyTypepublic String qualifiedTypeName()
GroovyTypejava.lang.String".qualifiedTypeName in interface GroovyTypepublic String simpleTypeName()
GroovyTypeOuter.Inner returns "Inner".simpleTypeName in interface GroovyTypepublic String typeName()
GroovyTypeString".typeName in interface GroovyTypepublic void addInterfaceName(String className)
public String firstSentenceCommentText()
firstSentenceCommentText in interface GroovyDocfirstSentenceCommentText in class SimpleGroovyDocpublic String commentText()
commentText in interface GroovyDoccommentText in class SimpleGroovyDocpublic static String replaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
public String replaceAllTagsCollated(String self, String preKey, String postKey, String valueSeparator, String postValues, Pattern regex)
public static String encodeAngleBracketsInTagBody(String text, Pattern regex)
text - GroovyDoc text to processregex - has to capture tag name in group 1 and tag body in group 2public void setNameWithTypeArgs(String nameWithTypeArgs)
public String getNameWithTypeArgs()