org.kuali.rice.krad.docextract

Class DocExtracter

java.lang.Object

org.kuali.rice.krad.docextract.DocExtracter

All Implemented Interfaces:

groovy.lang.GroovyObject

public class DocExtracter
extends Object
implements groovy.lang.GroovyObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocExtracter.SortedProperties

Constructor Summary

Constructors

Constructor and Description
DocExtracter()

Method Summary

Modifier and Type	Method and Description
static com.sun.javadoc.MethodDoc	findInterfaceMethodDoc(String methodName, Class[] interfaces, com.sun.javadoc.RootDoc doc)
static Object	generateDocProperties(String outputPath, String sourcePath, String sourcePackages, String excludePackages)
static String	getExcludePackages()
static Object	getGETTER_IS_PREFIX()
static Object	getGETTER_PREFIX()
static Object	getINHERIT_DOC_TAG()
groovy.lang.MetaClass	getMetaClass()
static String	getMethodDocText(String className, com.sun.javadoc.MethodDoc methodDoc, com.sun.javadoc.RootDoc doc)
static com.sun.javadoc.MethodDoc	getNoParamMethodFromClassDoc(com.sun.javadoc.ClassDoc classDoc, String methodName)
static String	getOutputPath()
static Object	getPROPERTIES_FILE_NAME()
Object	getProperty(String property)
static String	getSourcePackages()
static String	getSourcePath()
Object	invokeMethod(String method, Object arguments)
static boolean	isAnnotatedWith(com.sun.javadoc.ProgramElementDoc elementDoc, String... tagString)
static void	setExcludePackages(String value)
void	setMetaClass(groovy.lang.MetaClass mc)
static void	setOutputPath(String value)
void	setProperty(String property, Object value)
static void	setSourcePackages(String value)
static void	setSourcePath(String value)
static boolean	start(com.sun.javadoc.RootDoc doc)
static Object	writeDocsToPropertiesFile(com.sun.javadoc.RootDoc doc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocExtracter

public DocExtracter()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

getGETTER_PREFIX

public static final Object getGETTER_PREFIX()

getGETTER_IS_PREFIX

public static final Object getGETTER_IS_PREFIX()

getINHERIT_DOC_TAG

public static final Object getINHERIT_DOC_TAG()

getPROPERTIES_FILE_NAME

public static final Object getPROPERTIES_FILE_NAME()

getOutputPath

public static String getOutputPath()

setOutputPath

public static void setOutputPath(String value)

getSourcePath

public static String getSourcePath()

setSourcePath

public static void setSourcePath(String value)

getSourcePackages

public static String getSourcePackages()

setSourcePackages

public static void setSourcePackages(String value)

getExcludePackages

public static String getExcludePackages()

setExcludePackages

public static void setExcludePackages(String value)

generateDocProperties

public static Object generateDocProperties(String outputPath,
                                           String sourcePath,
                                           String sourcePackages,
                                           String excludePackages)

start

public static boolean start(com.sun.javadoc.RootDoc doc)

writeDocsToPropertiesFile

public static Object writeDocsToPropertiesFile(com.sun.javadoc.RootDoc doc)

getMethodDocText

public static String getMethodDocText(String className,
                                      com.sun.javadoc.MethodDoc methodDoc,
                                      com.sun.javadoc.RootDoc doc)

findInterfaceMethodDoc

public static com.sun.javadoc.MethodDoc findInterfaceMethodDoc(String methodName,
                                                               Class[] interfaces,
                                                               com.sun.javadoc.RootDoc doc)

getNoParamMethodFromClassDoc

public static com.sun.javadoc.MethodDoc getNoParamMethodFromClassDoc(com.sun.javadoc.ClassDoc classDoc,
                                                                     String methodName)

isAnnotatedWith

public static boolean isAnnotatedWith(com.sun.javadoc.ProgramElementDoc elementDoc,
                                      String... tagString)