jdiff
public class API extends Object
Field Summary | |
---|---|
Hashtable | classes_
The list of all the classes.
|
ClassAPI | currClass_ The current class being added to during parsing. |
ConstructorAPI | currCtor_ The current constructor being added to during parsing. |
FieldAPI | currField_ The current field being added to during parsing. |
MethodAPI | currMethod_ The current method being added to during parsing. |
PackageAPI | currPkg_ The current package being added to during parsing. |
static int | indentInc Amount by which to increment each indentation. |
String | name_
The String which identifies this API, e.g. |
List | packages_
The list of all the top-level packages.
|
Constructor Summary | |
---|---|
API() Default constructor. |
Method Summary | |
---|---|
static String | convertHTMLTagsToXHTML(String htmlText)
NOT USED.
|
void | dump() Display the contents of the API object. |
static void | dumpClass(ClassAPI c, int indent)
Display the contents of a ClassAPI object.
|
static void | dumpCtor(ConstructorAPI c, int indent)
Display the contents of a constructor.
|
static void | dumpField(FieldAPI f, int indent)
Display the contents of a field.
|
static void | dumpMethod(MethodAPI m, int indent)
Display the contents of a MethodAPI object.
|
static void | dumpModifiers(Modifiers m, int indent)
Display the contents of the Modifiers object.
|
void | dumpPackage(PackageAPI pkg, int indent)
Display the contents of a PackageAPI object.
|
static void | dumpParam(ParamAPI p, int indent)
Display the contents of a parameter.
|
static String | hideHTMLTags(String htmlText)
Convert all HTML tags to text by stuffing text into the HTML tag
to stop it being an HTML or XML tag. |
static String | showHTMLTags(String text)
Convert text with stuffed HTML tags ("lEsS_tHaN", etc) into HTML text. |
static String | stuffHTMLTags(String htmlText)
Convert all HTML tags to text by placing them inside a CDATA element.
|
with
. Just for the small number of HMTL tags which don't require a matching end tag. Also make HTML conform to the simple HTML requirements such as no double hyphens. Double hyphens are replaced by - and the character entity for a hyphen. Cases where this fails and has to be corrected in the XML by hand: Attributes' values missing their double quotes , e.g. size=-2 Mangled HTML tags e.g. <ttt>NOT USED. There is often too much bad HTML in doc blocks to try to handle every case correctly. Better just to stuff the *lt; and &: characters with stuffHTMLTags(). Though the resulting XML is not as elegant, it does the job with less intervention by the user.
Parameters: c The given ClassAPI object. indent The number of spaces to indent the output.
Parameters: c The given constructor object. indent The number of spaces to indent the output.
Parameters: f The given field object. indent The number of spaces to indent the output.
Parameters: m The given MethodAPI object. indent The number of spaces to indent the output.
Parameters: c The given Modifiers object. indent The number of spaces to indent the output.
Parameters: pkg The given PackageAPI object. indent The number of spaces to indent the output.
Parameters: p The given parameter object. indent The number of spaces to indent the output.
foo
"
becomes "lEsS_tHaNcode>foolEsS_tHaN/code>". Replace all <
characters
with the string "lEsS_tHaN". Also replace & character with the
string "aNd_cHaR" to avoid text entities. Also replace "
character with the
string "qUoTe_cHaR".