|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.thoughtworks.qdox.JavaDocBuilder
Simple facade to QDox allowing a source tree to be parsed and the resulting object model navigated.
// -- Create JavaDocBuilder
JavaDocBuilder builder = new JavaDocBuilder();
// -- Add some files
// Reading a single source file.
builder.addSource(new FileReader("MyFile.java"));
// Reading from another kind of input stream.
builder.addSource(new StringReader("package test; public class Hello {}"));
// Adding all .java files in a source tree (recursively).
builder.addSourceTree(new File("mysrcdir"));
// -- Retrieve source files
JavaSource[] source = builder.getSources();
Constructor Summary | |
JavaDocBuilder()
|
|
JavaDocBuilder(DocletTagFactory docletTagFactory)
|
Method Summary | |
JavaSource |
addSource(java.io.File file)
|
JavaSource |
addSource(java.io.Reader reader)
|
JavaSource |
addSource(java.io.Reader reader,
java.lang.String sourceInfo)
|
JavaSource |
addSource(java.net.URL url)
|
void |
addSourceTree(java.io.File file)
|
JavaClass |
getClassByName(java.lang.String name)
|
JavaClass[] |
getClasses()
Returns all the classes found in all the sources, including inner classes and "extra" classes (multiple outer classes defined in the same source file). |
ClassLibrary |
getClassLibrary()
|
JavaSource[] |
getSources()
|
static JavaDocBuilder |
load(java.io.File file)
Note that after loading JavaDocBuilder classloaders need to be re-added. |
void |
save(java.io.File file)
|
java.util.List |
search(Searcher searcher)
|
void |
setDebugLexer(boolean debugLexer)
Forces QDox to dump tokens returned from lexer to System.err. |
void |
setDebugParser(boolean debugParser)
Forces QDox to dump parser states to System.out. |
void |
setEncoding(java.lang.String encoding)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public JavaDocBuilder()
public JavaDocBuilder(DocletTagFactory docletTagFactory)
Method Detail |
public JavaClass getClassByName(java.lang.String name)
getClassByName
in interface JavaClassCache
public JavaSource addSource(java.io.Reader reader)
public JavaSource addSource(java.io.Reader reader, java.lang.String sourceInfo)
public JavaSource addSource(java.io.File file) throws java.io.IOException, java.io.FileNotFoundException
java.io.IOException
java.io.FileNotFoundException
public JavaSource addSource(java.net.URL url) throws java.io.IOException, java.io.FileNotFoundException
java.io.IOException
java.io.FileNotFoundException
public JavaSource[] getSources()
public JavaClass[] getClasses()
getClasses
in interface JavaClassCache
public void addSourceTree(java.io.File file)
public java.util.List search(Searcher searcher)
public ClassLibrary getClassLibrary()
public void save(java.io.File file) throws java.io.IOException
java.io.IOException
public static JavaDocBuilder load(java.io.File file) throws java.io.IOException
java.io.IOException
public void setEncoding(java.lang.String encoding)
public void setDebugLexer(boolean debugLexer)
public void setDebugParser(boolean debugParser)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |