|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
org.codehaus.groovy.tools.groovydoc.SimpleGroovyProgramElementDoc
org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc
public class SimpleGroovyClassDoc
Field Summary | |
---|---|
private static java.util.regex.Pattern |
CODE_REGEX
|
private java.util.List<GroovyConstructorDoc> |
constructors
|
private java.util.List<GroovyFieldDoc> |
enumConstants
|
private java.util.List<GroovyFieldDoc> |
fields
|
private java.lang.String |
fullPathName
|
private java.util.List<java.lang.String> |
importedClassesAndPackages
|
private java.util.List<GroovyClassDoc> |
interfaceClasses
|
private java.util.List<java.lang.String> |
interfaceNames
|
private static java.util.regex.Pattern |
LINK_REGEX
|
private java.util.List<LinkArgument> |
links
|
private java.util.List<GroovyMethodDoc> |
methods
|
private java.util.List<GroovyClassDoc> |
nested
|
private GroovyClassDoc |
outer
|
private java.util.List<GroovyFieldDoc> |
properties
|
private GroovyClassDoc |
superClass
|
private java.lang.String |
superClassName
|
private static java.util.regex.Pattern |
TAG_REGEX
|
Constructor Summary | |
---|---|
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)
|
Method Summary | |
---|---|
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)
|
private java.lang.String |
buildUrl(java.lang.String relativeRoot,
java.lang.String[] target,
java.lang.String shortClassName)
|
GroovyConstructorDoc[] |
constructors()
returns a sorted array of constructors |
GroovyConstructorDoc[] |
constructors(boolean filter)
|
private java.lang.String |
decodeSpecialSymbols(java.lang.String text)
|
boolean |
definesSerializableFields()
|
private java.lang.String |
encodeSpecialSymbols(java.lang.String text)
|
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)
|
private java.lang.Class |
getClassOf(java.lang.String next)
|
java.lang.String |
getDocUrl(java.lang.String type)
|
java.lang.String |
getDocUrl(java.lang.String type,
boolean full)
|
java.lang.String |
getFullPathName()
|
private java.util.Set<GroovyClassDoc> |
getJavaInterfaces(ExternalGroovyClassDoc d)
|
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)
|
(package private) void |
resolve(GroovyRootDoc rootDoc)
|
private GroovyClassDoc |
resolveClass(GroovyRootDoc rootDoc,
java.lang.String name)
|
private java.lang.Class |
resolveExternalClass(java.lang.String name)
|
private java.lang.Class |
resolveExternalClassFromImport(java.lang.String name)
|
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. |
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, setPrivate, setProtected, setPublic, setStatic |
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyType |
---|
toString |
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.GroovyDoc |
---|
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
private static final java.util.regex.Pattern TAG_REGEX
private static final java.util.regex.Pattern LINK_REGEX
private static final java.util.regex.Pattern CODE_REGEX
private final java.util.List<GroovyConstructorDoc> constructors
private final java.util.List<GroovyFieldDoc> fields
private final java.util.List<GroovyFieldDoc> properties
private final java.util.List<GroovyFieldDoc> enumConstants
private final java.util.List<GroovyMethodDoc> methods
private final java.util.List<java.lang.String> importedClassesAndPackages
private final java.util.List<java.lang.String> interfaceNames
private final java.util.List<GroovyClassDoc> interfaceClasses
private final java.util.List<GroovyClassDoc> nested
private final java.util.List<LinkArgument> links
private GroovyClassDoc superClass
private GroovyClassDoc outer
private java.lang.String superClassName
private java.lang.String fullPathName
Constructor Detail |
---|
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)
Method Detail |
---|
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()
private java.util.Set<GroovyClassDoc> getJavaInterfaces(ExternalGroovyClassDoc d)
private java.lang.Class getClassOf(java.lang.String next)
void resolve(GroovyRootDoc rootDoc)
public java.lang.String getDocUrl(java.lang.String type)
public java.lang.String getDocUrl(java.lang.String type, boolean full)
private java.lang.String buildUrl(java.lang.String relativeRoot, java.lang.String[] target, java.lang.String shortClassName)
private GroovyClassDoc resolveClass(GroovyRootDoc rootDoc, java.lang.String name)
private java.lang.Class resolveExternalClassFromImport(java.lang.String name)
private java.lang.Class resolveExternalClass(java.lang.String name)
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)
private java.lang.String encodeSpecialSymbols(java.lang.String text)
private java.lang.String decodeSpecialSymbols(java.lang.String text)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |