de.berlios.suzy.parser
Class Parser

java.lang.Object
  de.berlios.suzy.parser.Parser

public class Parser
extends java.lang.Object

The Parser class will create a List of classes. Each class will contain information about all methods and fields. The entire api available will be written to a file api.dat. It can be read by invoking read(). The parsing does require a lot of memory and takes quite some time, be patient. Once the api.dat file is created, it will no be changed.
suggested when creating a new api.dat: -Xmx1024M
api.dat is just a List written using an ObjectOutputStream and read using an ObjectInputStream.

Author:

honk

Constructor Summary

Parser()

Method Summary

static ClassInfo[]	read() Reads the file api.dat and creates an array containsing all classes in form of ClassInfo objects.
static boolean	start(com.sun.javadoc.RootDoc root) The entry point for javadoc.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parser

public Parser()

Method Detail

start

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

The entry point for javadoc. This method actually creates all

Parameters:

root - the root node javadoc gives

Returns:

true

read

public static ClassInfo[] read()

Reads the file api.dat and creates an array containsing all classes in form of ClassInfo objects. Every class contains a List with methods as MethodInfo and fields as FieldInfo.

Returns:

a List containing all classes from the available api