|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.thoughtworks.qdox.JavaDocBuilder
public class 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();
Nested Class Summary | |
---|---|
static class |
JavaDocBuilder.DefaultErrorHandler
|
static interface |
JavaDocBuilder.ErrorHandler
|
Constructor Summary | |
---|---|
JavaDocBuilder()
|
|
JavaDocBuilder(ClassLibrary classLibrary)
|
|
JavaDocBuilder(DocletTagFactory docletTagFactory)
|
|
JavaDocBuilder(DocletTagFactory docletTagFactory,
ClassLibrary classLibrary)
|
Method Summary | |
---|---|
JavaSource |
addSource(File file)
|
JavaSource |
addSource(Reader reader)
|
JavaSource |
addSource(Reader reader,
String sourceInfo)
|
JavaSource |
addSource(URL url)
|
void |
addSourceTree(File file)
Add all files in a directory (and subdirs, recursively). |
void |
addSourceTree(File file,
FileVisitor errorHandler)
Add all files in a directory (and subdirs, recursively). |
protected JavaClass |
createBinaryClass(String name)
|
protected JavaClass |
createUnknownClass(String name)
|
JavaClass |
getClassByName(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()
|
JavaPackage[] |
getPackages()
Returns all the packages found in all the sources. |
JavaSource[] |
getSources()
|
static JavaDocBuilder |
load(File file)
Note that after loading JavaDocBuilder classloaders need to be re-added. |
void |
save(File file)
|
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(String encoding)
|
void |
setErrorHandler(JavaDocBuilder.ErrorHandler errorHandler)
|
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)
public JavaDocBuilder(ClassLibrary classLibrary)
public JavaDocBuilder(DocletTagFactory docletTagFactory, ClassLibrary classLibrary)
Method Detail |
---|
public JavaClass getClassByName(String name)
protected JavaClass createUnknownClass(String name)
protected JavaClass createBinaryClass(String name)
public JavaSource addSource(Reader reader)
public JavaSource addSource(Reader reader, String sourceInfo)
public JavaSource addSource(File file) throws IOException, FileNotFoundException
IOException
FileNotFoundException
public JavaSource addSource(URL url) throws IOException, FileNotFoundException
IOException
FileNotFoundException
public void setErrorHandler(JavaDocBuilder.ErrorHandler errorHandler)
public JavaSource[] getSources()
public JavaClass[] getClasses()
public JavaPackage[] getPackages()
public void addSourceTree(File file)
public void addSourceTree(File file, FileVisitor errorHandler)
public List search(Searcher searcher)
public ClassLibrary getClassLibrary()
public void save(File file) throws IOException
IOException
public static JavaDocBuilder load(File file) throws IOException
IOException
public void setEncoding(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 |