com.thoughtworks.qdox
public class JavaDocBuilder extends Object implements Serializable, JavaClassCache
// -- 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();
| Field Summary | |
|---|---|
| Map | classes |
| ClassLibrary | classLibrary |
| DocletTagFactory | docletTagFactory |
| String | encoding |
| List | sources |
| Constructor Summary | |
|---|---|
| JavaDocBuilder() | |
| JavaDocBuilder(DocletTagFactory docletTagFactory) | |
| Method Summary | |
|---|---|
| void | addClass(JavaClass cls) |
| void | addClasses(JavaSource source) |
| void | addClassesRecursive(JavaSource javaSource, Set resultSet) |
| void | addClassesRecursive(JavaClass javaClass, Set set) |
| void | addField(Field field, ModelBuilder binaryBuilder) |
| void | addMethodOrConstructor(Member member, ModelBuilder binaryBuilder) |
| void | addModifiers(Set set, int modifier) |
| JavaSource | addSource(Reader reader) |
| JavaSource | addSource(Reader reader, String sourceInfo) |
| JavaSource | addSource(File file) |
| JavaSource | addSource(URL url) |
| void | addSourceTree(File file) |
| JavaClass | createBinaryClass(String name) |
| 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() |
| String | getClassName(String fullClassName) |
| static int | getDimension(Class c) |
| String | getPackageName(String fullClassName) |
| JavaSource[] | getSources() |
| static String | getTypeName(Class c) |
| 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 | setEncoding(String encoding) |
Returns: all the classes found in all the sources.
Since: 1.3