org.codehaus.groovy.tools.groovydoc
public class SimpleGroovyClassDoc extends SimpleGroovyProgramElementDoc implements GroovyClassDoc
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, DIV, DIV_ASSIGN, DOLLAR, DOT, DYNAMIC_MEMBER, ELIST, ELVIS_OPERATOR, EMPTY_STAT, ENUM_CONSTANT_DEF, ENUM_DEF, EOF, EQUAL, ESC, EXPONENT, EXPR, EXTENDS_CLAUSE, FINAL, FLOAT_SUFFIX, FOR_CONDITION, FOR_EACH_CLAUSE, FOR_IN_ITERABLE, FOR_INIT, FOR_ITERATOR, GE, GT, HEX_DIGIT, IDENT, 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_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, NLS, NOT_EQUAL, 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, 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(java.util.List<java.lang.String> importedClassesAndPackages,
java.lang.String name) |
SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages,
java.lang.String name,
java.util.List<LinkArgument> links) |
Modifier and Type | Method and Description |
---|---|
boolean |
add(GroovyConstructorDoc constructor) |
boolean |
add(GroovyFieldDoc field) |
boolean |
add(GroovyMethodDoc method) |
boolean |
addEnumConstant(GroovyFieldDoc field) |
void |
addInterfaceName(java.lang.String className) |
boolean |
addNested(GroovyClassDoc nestedClass) |
boolean |
addProperty(GroovyFieldDoc property) |
GroovyConstructorDoc[] |
constructors()
returns a sorted array of constructors
|
GroovyConstructorDoc[] |
constructors(boolean filter) |
boolean |
definesSerializableFields() |
GroovyFieldDoc[] |
enumConstants()
returns a sorted array of enum constants
|
GroovyFieldDoc[] |
fields()
returns a sorted array of fields
|
GroovyFieldDoc[] |
fields(boolean filter) |
GroovyClassDoc |
findClass(java.lang.String className) |
java.lang.String |
getDocUrl(java.lang.String type) |
java.lang.String |
getDocUrl(java.lang.String type,
boolean full) |
java.lang.String |
getFullPathName() |
GroovyClassDoc |
getOuter() |
java.util.List<GroovyClassDoc> |
getParentClasses() |
java.util.Set<GroovyClassDoc> |
getParentInterfaces() |
java.lang.String |
getRelativeRootPath() |
java.lang.String |
getSuperClassName() |
GroovyClassDoc[] |
importedClasses() |
GroovyPackageDoc[] |
importedPackages() |
GroovyClassDoc[] |
innerClasses()
returns a sorted array of nested classes and interfaces
|
GroovyClassDoc[] |
innerClasses(boolean filter) |
GroovyClassDoc[] |
interfaces() |
GroovyType[] |
interfaceTypes() |
boolean |
isAbstract() |
boolean |
isExternalizable() |
boolean |
isPrimitive() |
boolean |
isSerializable() |
GroovyMethodDoc[] |
methods()
returns a sorted array of methods
|
GroovyMethodDoc[] |
methods(boolean filter) |
GroovyFieldDoc[] |
properties()
returns a sorted array of properties
|
java.lang.String |
qualifiedTypeName()
The qualified name of this type excluding any dimension information.
|
java.lang.String |
replaceAllTags(java.lang.String self,
java.lang.String s1,
java.lang.String s2,
java.util.regex.Pattern regex) |
java.lang.String |
replaceTags(java.lang.String comment) |
GroovyFieldDoc[] |
serializableFields() |
GroovyMethodDoc[] |
serializationMethods() |
void |
setFullPathName(java.lang.String fullPathName) |
void |
setOuter(GroovyClassDoc outer) |
void |
setRawCommentText(java.lang.String rawCommentText) |
void |
setSuperClass(GroovyClassDoc doc) |
void |
setSuperClassName(java.lang.String className) |
java.lang.String |
simpleTypeName()
The unqualified name of this type excluding any dimension or nesting information.
|
boolean |
subclassOf(GroovyClassDoc gcd) |
GroovyClassDoc |
superclass() |
GroovyType |
superclassType() |
java.lang.String |
typeName()
The unqualified name of this type excluding any dimension information.
|
addAnnotationRef, annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName, setContainingPackage, setFinal, setPrivate, setProtected, setPublic, setStatic
calculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setTokenType, tags, tokenType, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
toString
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name
public SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.lang.String name, java.util.List<LinkArgument> links)
public SimpleGroovyClassDoc(java.util.List<java.lang.String> importedClassesAndPackages, java.lang.String name)
public GroovyConstructorDoc[] constructors()
constructors
in interface GroovyClassDoc
public boolean add(GroovyConstructorDoc constructor)
public GroovyClassDoc getOuter()
public void setOuter(GroovyClassDoc outer)
public GroovyClassDoc[] innerClasses()
innerClasses
in interface GroovyClassDoc
public boolean addNested(GroovyClassDoc nestedClass)
public GroovyFieldDoc[] fields()
fields
in interface GroovyClassDoc
public boolean add(GroovyFieldDoc field)
public GroovyFieldDoc[] properties()
properties
in interface GroovyClassDoc
public boolean addProperty(GroovyFieldDoc property)
public GroovyFieldDoc[] enumConstants()
enumConstants
in interface GroovyClassDoc
public boolean addEnumConstant(GroovyFieldDoc field)
public GroovyMethodDoc[] methods()
methods
in interface GroovyClassDoc
public boolean add(GroovyMethodDoc method)
public java.lang.String getSuperClassName()
public void setSuperClassName(java.lang.String className)
public GroovyClassDoc superclass()
superclass
in interface GroovyClassDoc
public void setSuperClass(GroovyClassDoc doc)
public java.lang.String getFullPathName()
getFullPathName
in interface GroovyClassDoc
public void setFullPathName(java.lang.String fullPathName)
public java.lang.String getRelativeRootPath()
getRelativeRootPath
in interface GroovyClassDoc
public java.util.List<GroovyClassDoc> getParentClasses()
public java.util.Set<GroovyClassDoc> getParentInterfaces()
public java.lang.String getDocUrl(java.lang.String type)
public java.lang.String getDocUrl(java.lang.String type, boolean full)
public GroovyConstructorDoc[] constructors(boolean filter)
constructors
in interface GroovyClassDoc
public boolean definesSerializableFields()
definesSerializableFields
in interface GroovyClassDoc
public GroovyFieldDoc[] fields(boolean filter)
fields
in interface GroovyClassDoc
public GroovyClassDoc findClass(java.lang.String className)
findClass
in interface GroovyClassDoc
public GroovyClassDoc[] importedClasses()
importedClasses
in interface GroovyClassDoc
public GroovyPackageDoc[] importedPackages()
importedPackages
in interface GroovyClassDoc
public GroovyClassDoc[] innerClasses(boolean filter)
innerClasses
in interface GroovyClassDoc
public GroovyClassDoc[] interfaces()
interfaces
in interface GroovyClassDoc
public GroovyType[] interfaceTypes()
interfaceTypes
in interface GroovyClassDoc
public boolean isAbstract()
isAbstract
in interface GroovyClassDoc
public boolean isExternalizable()
isExternalizable
in interface GroovyClassDoc
public boolean isSerializable()
isSerializable
in interface GroovyClassDoc
public GroovyMethodDoc[] methods(boolean filter)
methods
in interface GroovyClassDoc
public GroovyFieldDoc[] serializableFields()
serializableFields
in interface GroovyClassDoc
public GroovyMethodDoc[] serializationMethods()
serializationMethods
in interface GroovyClassDoc
public boolean subclassOf(GroovyClassDoc gcd)
subclassOf
in interface GroovyClassDoc
public GroovyType superclassType()
superclassType
in interface GroovyClassDoc
public boolean isPrimitive()
isPrimitive
in interface GroovyType
public java.lang.String qualifiedTypeName()
GroovyType
java.lang.String
".qualifiedTypeName
in interface GroovyType
public java.lang.String simpleTypeName()
GroovyType
Outer.Inner
returns "Inner
".simpleTypeName
in interface GroovyType
public java.lang.String typeName()
GroovyType
String
".typeName
in interface GroovyType
public void addInterfaceName(java.lang.String className)
public void setRawCommentText(java.lang.String rawCommentText)
setRawCommentText
in interface GroovyDoc
setRawCommentText
in class SimpleGroovyDoc
public java.lang.String replaceTags(java.lang.String comment)
public java.lang.String replaceAllTags(java.lang.String self, java.lang.String s1, java.lang.String s2, java.util.regex.Pattern regex)