|
Groovy 2.2.0 | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class SimpleGroovyClassDoc extends SimpleGroovyAbstractableElementDoc
Field Summary | |
---|---|
static Pattern |
CODE_REGEX
|
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
|
Constructor Summary | |
SimpleGroovyClassDoc(List importedClassesAndPackages, Map aliases, String name, List links)
|
|
SimpleGroovyClassDoc(List importedClassesAndPackages, Map aliases, String name)
|
|
SimpleGroovyClassDoc(List importedClassesAndPackages, String name)
|
Methods inherited from class SimpleGroovyAbstractableElementDoc | |
---|---|
isAbstract, setAbstract |
Methods inherited from class SimpleGroovyProgramElementDoc | |
---|---|
addAnnotationRef, annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifierSpecifier, modifiers, qualifiedName, setContainingPackage, setFinal, setPackagePrivate, setPrivate, setProtected, setPublic, setStatic |
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Field Detail |
---|
public static final Pattern CODE_REGEX
public static final Pattern LINK_REGEX
public static final Pattern LITERAL_REGEX
public static final Pattern NAME_ARGS_REGEX
public static final Pattern REF_LABEL_REGEX
public static final Pattern SPLIT_ARGS_REGEX
public static final Pattern TAG_REGEX
Constructor Detail |
---|
public SimpleGroovyClassDoc(List importedClassesAndPackages, Map aliases, String name, List links)
public SimpleGroovyClassDoc(List importedClassesAndPackages, Map aliases, String name)
public SimpleGroovyClassDoc(List importedClassesAndPackages, String name)
Method Detail |
---|
public boolean add(GroovyConstructorDoc constructor)
public boolean add(GroovyFieldDoc field)
public boolean add(GroovyMethodDoc method)
public boolean addEnumConstant(GroovyFieldDoc field)
public void addInterfaceName(String className)
public boolean addNested(GroovyClassDoc nestedClass)
public boolean addProperty(GroovyFieldDoc property)
public String commentText()
public GroovyConstructorDoc[] constructors()
public GroovyConstructorDoc[] constructors(boolean filter)
public static String decodeSpecialSymbols(String text)
public boolean definesSerializableFields()
public static String encodeAngleBrackets(String text)
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 2
public static String encodeSpecialSymbols(String text)
public GroovyFieldDoc[] enumConstants()
public GroovyFieldDoc[] fields()
public GroovyFieldDoc[] fields(boolean filter)
public GroovyClassDoc findClass(String className)
public String firstSentenceCommentText()
public String getDocUrl(String type)
public String getDocUrl(String type, boolean full)
public static String getDocUrl(String type, boolean full, List links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
public String getFullPathName()
public GroovyClassDoc getOuter()
public List getParentClasses()
public Set getParentInterfaces()
public String getRelativeRootPath()
public String getSuperClassName()
public GroovyClassDoc[] importedClasses()
public GroovyPackageDoc[] importedPackages()
public GroovyClassDoc[] innerClasses()
public GroovyClassDoc[] innerClasses(boolean filter)
public GroovyType[] interfaceTypes()
public GroovyClassDoc[] interfaces()
public boolean isExternalizable()
public boolean isGroovy()
public boolean isPrimitive()
public boolean isSerializable()
public GroovyMethodDoc[] methods()
public GroovyMethodDoc[] methods(boolean filter)
public GroovyFieldDoc[] properties()
public String qualifiedTypeName()
public String replaceAllTags(String self, String s1, String s2, Pattern regex)
public static String replaceAllTags(String self, String s1, String s2, Pattern regex, List links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
public String replaceAllTagsCollated(String self, String preKey, String postKey, String valueSeparator, String postValues, Pattern regex)
public String replaceTags(String comment)
public GroovyFieldDoc[] serializableFields()
public GroovyMethodDoc[] serializationMethods()
public void setFullPathName(String fullPathName)
public void setGroovy(boolean isgroovy)
public void setOuter(GroovyClassDoc outer)
public void setSuperClass(GroovyClassDoc doc)
public void setSuperClassName(String className)
public String simpleTypeName()
public boolean subclassOf(GroovyClassDoc gcd)
public GroovyClassDoc superclass()
public GroovyType superclassType()
public String typeName()
Copyright © 2003-2013 The Codehaus. All rights reserved.