jdiff
public class HTMLIndexes extends Object
Field Summary | |
---|---|
static boolean | logMissingSinces
Whether to log all missing @since tags to a file or not.
|
static PrintWriter | missingSincesFile The file used to output details of missing @since tags. |
Constructor Summary | |
---|---|
HTMLIndexes(HTMLReportGenerator h) Constructor. |
Method Summary | |
---|---|
void | emitAllBottomLeftFiles(String packagesIndexName, String classesIndexName, String constructorsIndexName, String methodsIndexName, String fieldsIndexName, String allDiffsIndexName, APIDiff apiDiff) Emit all the bottom left frame index files. |
void | emitAllDiffsIndex(APIDiff apiDiff, int indexType)
Emit the index of all changes, which appears in the bottom left frame.
|
void | emitBottomLeftFile(String indexBaseName, APIDiff apiDiff, int indexType, String programElementType)
Emit a single bottom left frame with the given kind of differences for
the given program element type in an alphabetical index.
|
void | emitClassesIndex(APIDiff apiDiff, int indexType) Emit the index of classes, which appears in the bottom left frame. |
char | emitClassIndexEntry(Index cls, char oldsw, int multipleMarker) Emit an index entry for a class. |
void | emitConstructorsIndex(APIDiff apiDiff, int indexType)
Emit the index of all constructors, which appears in the bottom left
frame. |
char | emitCtorIndexEntry(Index ctor, char oldsw, int multipleMarker) Emit an index entry for a constructor. |
char | emitFieldIndexEntry(Index fld, char oldsw, int multipleMarker) Emit an index entry for a field. |
void | emitFieldsIndex(APIDiff apiDiff, int indexType)
Emit the index of all fields, which appears in the bottom left frame. |
void | emitIndexEntries(Iterator iter)
Emit all the entries and links for the given iterator
to their respective files. |
char | emitIndexEntry(Index currIndex, char oldsw, int multipleMarker)
Emit a single entry and the link to its file.
|
char | emitIndexEntryForAny(Index currIndex, char oldsw, int multipleMarker) Call the appropriate *IndexEntry method for each entry. |
char | emitMethodIndexEntry(Index meth, char oldsw, int multipleMarker) Emit an index entry for a method. |
void | emitMethodsIndex(APIDiff apiDiff, int indexType)
Emit the index of all methods, which appears in the bottom left frame. |
void | emitMissingSinces(Iterator iter)
Emit elements in the given iterator which were added and
missing @since tags. |
char | emitPackageIndexEntry(Index pkg, char oldsw)
Emit an index entry for a package.
|
void | emitPackagesIndex(APIDiff apiDiff, int indexType) Emit the index of packages, which appears in the bottom left frame. |
Parameters: indexBaseName The base name of the index file. apiDiff The root element containing all the API differences. indexType 0 = removals only, 1 = additions only, 2 = changes only, 3 = all differences, programElementType "Package", "Class", "Constructor", "Method", "Field" or "All".
Parameters: programElementType "Class", "Constructor", "Method", or "Field".