| "); writeText(" ©2008 Google - "); writeText(" Code Home - "); writeText(" Site Terms of Service - "); writeText(" Privacy Policy "); writeText(" "); writeText(" | "); writeText("
This document details the changes in the Android framework API. It shows "); writeText("additions, modifications, and removals for packages, classes, methods, and "); writeText("fields. Each reference to an API change includes a brief description of the "); writeText("API and an explanation of the change and suggested workaround, where available.
"); writeText("The differences described in this report are based a comparison of the APIs "); writeText("whose versions are specified in the upper-right corner of this page. It compares a "); writeText("newer \"to\" API to an older \"from\" version, noting any changes relative to the "); writeText("older API. So, for example, indicated API removals are no longer present in the \"to\" "); writeText("API.
"); writeText("To navigate the report, use the \"Select a Diffs Index\" and \"Filter the Index\" "); writeText("controls on the left. The report uses text formatting to indicate interface names, "); writeText("links to reference documentation, and links to change "); writeText("description.
"); writeText("For more information about the Android framework API and SDK, "); writeText("see the Android product site.
"); // Write the contents and the other files as well writeReport(apiDiff); writeHTMLFooter(); reportFile.close(); } catch(IOException e) { System.out.println("IO Error while attempting to create " + changesSummaryName); System.out.println("Error: " + e.getMessage()); System.exit(1); } // Now generate all the other files for multiple frames. // // The top-level changes.html frames file where everything starts. String tln = fullReportFileName + reportFileExt; // The file for the top-left frame. String tlf = fullReportFileName + JDiff.DIR_SEP + "jdiff_topleftframe" + reportFileExt; // The default file for the bottom-left frame is the one with the // most information in it. String allDiffsIndexName = fullReportFileName + JDiff.DIR_SEP + "alldiffs_index"; // Other indexes for the bottom-left frame. String packagesIndexName = fullReportFileName + JDiff.DIR_SEP + "packages_index"; String classesIndexName = fullReportFileName + JDiff.DIR_SEP + "classes_index"; String constructorsIndexName = fullReportFileName + JDiff.DIR_SEP + "constructors_index"; String methodsIndexName = fullReportFileName + JDiff.DIR_SEP + "methods_index"; String fieldsIndexName = fullReportFileName + JDiff.DIR_SEP + "fields_index"; HTMLFiles hf = new HTMLFiles(this); hf.emitTopLevelFile(tln, apiDiff); hf.emitTopLeftFile(tlf); hf.emitHelp(fullReportFileName, apiDiff); hf.emitStylesheet(); HTMLIndexes h = new HTMLIndexes(this); h.emitAllBottomLeftFiles(packagesIndexName, classesIndexName, constructorsIndexName, methodsIndexName, fieldsIndexName, allDiffsIndexName, apiDiff); if (doStats) { // The file for the statistical report. String sf = fullReportFileName + JDiff.DIR_SEP + "jdiff_statistics" + reportFileExt; HTMLStatistics stats = new HTMLStatistics(this); stats.emitStatistics(sf, apiDiff); } } /** * Write the HTML report. * * The top section describes all the packages added (with links) and * removed, and the changed packages section has links which takes you * to a section for each package. This pattern continues for classes and * constructors, methods and fields. */ public void writeReport(APIDiff apiDiff) { // Report packages which were removed in the new API if (apiDiff.packagesRemoved.size() != 0) { writeTableStart("Removed Packages", 2); Iterator iter = apiDiff.packagesRemoved.iterator(); while (iter.hasNext()) { PackageAPI pkgAPI = (PackageAPI)(iter.next()); String pkgName = pkgAPI.name_; if (trace) System.out.println("Package " + pkgName + " was removed."); writePackageTableEntry(pkgName, 0, pkgAPI.doc_, false); } writeTableEnd(); } // Report packages which were added in the new API if (apiDiff.packagesAdded.size() != 0) { writeTableStart("Added Packages", 2); Iterator iter = apiDiff.packagesAdded.iterator(); while (iter.hasNext()) { PackageAPI pkgAPI = (PackageAPI)(iter.next()); String pkgName = pkgAPI.name_; if (trace) System.out.println("Package " + pkgName + " was added."); writePackageTableEntry(pkgName, 1, pkgAPI.doc_, false); } writeTableEnd(); } // Report packages which were changed in the new API if (apiDiff.packagesChanged.size() != 0) { // Emit a table of changed packages, with links to the file // for each package. writeTableStart("Changed Packages", 3); Iterator iter = apiDiff.packagesChanged.iterator(); while (iter.hasNext()) { PackageDiff pkgDiff = (PackageDiff)(iter.next()); String pkgName = pkgDiff.name_; if (trace) System.out.println("Package " + pkgName + " was changed."); writePackageTableEntry(pkgName, 2, null, false); } writeTableEnd(); writeText(""); // Now emit a separate file for each changed package. writeText(""); PackageDiff[] pkgDiffs = new PackageDiff[apiDiff.packagesChanged.size()]; pkgDiffs = (PackageDiff[])apiDiff.packagesChanged.toArray(pkgDiffs); for (int i = 0; i < pkgDiffs.length; i++) { reportChangedPackage(pkgDiffs, i); } } writeText("| "); writeText(" ©2008 Google - "); writeText(" Code Home - "); writeText(" Site Terms of Service - "); writeText(" Privacy Policy "); writeText(" "); writeText(" | "); writeText("
" + classDiff.inheritanceChange_ + ""); // Report changes in documentation if (reportDocChanges && classDiff.documentationChange_ != null) { String oldClassRef = null; if (oldDocPrefix != null) { oldClassRef = pkgName + "." + className; oldClassRef = oldClassRef.replace('.', '/'); if (className.indexOf('.') != -1) { oldClassRef = pkgName + "."; oldClassRef = oldClassRef.replace('.', '/'); oldClassRef = oldDocPrefix + oldClassRef + className; } else { oldClassRef = oldDocPrefix + oldClassRef; } } if (oldDocPrefix != null) classDiff.documentationChange_ += "old to "; else classDiff.documentationChange_ += "old to "; classDiff.documentationChange_ += "new. "; writeText(classDiff.documentationChange_); } if (classDiff.modifiersChange_ != null) writeText("
" + classDiff.modifiersChange_); reportAllCtors(pkgName, classDiff); reportAllMethods(pkgName, classDiff); reportAllFields(pkgName, classDiff); writeSectionFooter(pkgName, prevClassRef, nextClassRef, className, 2); writeHTMLFooter(); reportFile.close(); reportFile = oldReportFile; } /** * Write out the details of constructors in a class. */ public void reportAllCtors(String pkgName, ClassDiff classDiff) { String className = classDiff.name_; writeText(""); // Named anchor // Report ctors which were removed in the new API if (classDiff.ctorsRemoved.size() != 0) { writeTableStart("Removed Constructors", 2); Iterator iter = classDiff.ctorsRemoved.iterator(); while (iter.hasNext()) { ConstructorAPI ctorAPI = (ConstructorAPI)(iter.next()); String ctorType = ctorAPI.type_; if (ctorType.compareTo("void") == 0) ctorType = ""; String id = className + "(" + ctorType + ")"; if (trace) System.out.println("Constructor " + id + " was removed."); writeCtorTableEntry(pkgName, className, ctorType, 0, ctorAPI.doc_, false); } writeTableEnd(); } // Report ctors which were added in the new API if (classDiff.ctorsAdded.size() != 0) { writeTableStart("Added Constructors", 2); Iterator iter = classDiff.ctorsAdded.iterator(); while (iter.hasNext()) { ConstructorAPI ctorAPI = (ConstructorAPI)(iter.next()); String ctorType = ctorAPI.type_; if (ctorType.compareTo("void") == 0) ctorType = ""; String id = className + "(" + ctorType + ")"; if (trace) System.out.println("Constructor " + id + " was added."); writeCtorTableEntry(pkgName, className, ctorType, 1, ctorAPI.doc_, false); } writeTableEnd(); } // Report ctors which were changed in the new API if (classDiff.ctorsChanged.size() != 0) { // Emit a table of changed classes, with links to the section // for each class. writeTableStart("Changed Constructors", 3); Iterator iter = classDiff.ctorsChanged.iterator(); while (iter.hasNext()) { MemberDiff memberDiff = (MemberDiff)(iter.next()); if (trace) System.out.println("Constructor for " + className + " was changed from " + memberDiff.oldType_ + " to " + memberDiff.newType_); writeCtorChangedTableEntry(pkgName, className, memberDiff); } writeTableEnd(); } } /** * Write out the details of methods in a class. */ public void reportAllMethods(String pkgName, ClassDiff classDiff) { writeText(""); // Named anchor String className = classDiff.name_; // Report methods which were removed in the new API if (classDiff.methodsRemoved.size() != 0) { writeTableStart("Removed Methods", 2); Iterator iter = classDiff.methodsRemoved.iterator(); while (iter.hasNext()) { MethodAPI methodAPI = (MethodAPI)(iter.next()); String methodName = methodAPI.name_ + "(" + methodAPI.getSignature() + ")"; if (trace) System.out.println("Method " + methodName + " was removed."); writeMethodTableEntry(pkgName, className, methodAPI, 0, methodAPI.doc_, false); } writeTableEnd(); } // Report methods which were added in the new API if (classDiff.methodsAdded.size() != 0) { writeTableStart("Added Methods", 2); Iterator iter = classDiff.methodsAdded.iterator(); while (iter.hasNext()) { MethodAPI methodAPI = (MethodAPI)(iter.next()); String methodName = methodAPI.name_ + "(" + methodAPI.getSignature() + ")"; if (trace) System.out.println("Method " + methodName + " was added."); writeMethodTableEntry(pkgName, className, methodAPI, 1, methodAPI.doc_, false); } writeTableEnd(); } // Report methods which were changed in the new API if (classDiff.methodsChanged.size() != 0) { // Emit a table of changed methods. writeTableStart("Changed Methods", 3); Iterator iter = classDiff.methodsChanged.iterator(); while (iter.hasNext()) { MemberDiff memberDiff = (MemberDiff)(iter.next()); if (trace) System.out.println("Method " + memberDiff.name_ + " was changed."); writeMethodChangedTableEntry(pkgName, className, memberDiff); } writeTableEnd(); } } /** * Write out the details of fields in a class. */ public void reportAllFields(String pkgName, ClassDiff classDiff) { writeText(""); // Named anchor String className = classDiff.name_; // Report fields which were removed in the new API if (classDiff.fieldsRemoved.size() != 0) { writeTableStart("Removed Fields", 2); Iterator iter = classDiff.fieldsRemoved.iterator(); while (iter.hasNext()) { FieldAPI fieldAPI = (FieldAPI)(iter.next()); String fieldName = fieldAPI.name_; if (trace) System.out.println("Field " + fieldName + " was removed."); writeFieldTableEntry(pkgName, className, fieldAPI, 0, fieldAPI.doc_, false); } writeTableEnd(); } // Report fields which were added in the new API if (classDiff.fieldsAdded.size() != 0) { writeTableStart("Added Fields", 2); Iterator iter = classDiff.fieldsAdded.iterator(); while (iter.hasNext()) { FieldAPI fieldAPI = (FieldAPI)(iter.next()); String fieldName = fieldAPI.name_; if (trace) System.out.println("Field " + fieldName + " was added."); writeFieldTableEntry(pkgName, className, fieldAPI, 1, fieldAPI.doc_, false); } writeTableEnd(); } // Report fields which were changed in the new API if (classDiff.fieldsChanged.size() != 0) { // Emit a table of changed classes, with links to the section // for each class. writeTableStart("Changed Fields", 3); Iterator iter = classDiff.fieldsChanged.iterator(); while (iter.hasNext()) { MemberDiff memberDiff = (MemberDiff)(iter.next()); if (trace) System.out.println("Field " + pkgName + "." + className + "." + memberDiff.name_ + " was changed from " + memberDiff.oldType_ + " to " + memberDiff.newType_); writeFieldChangedTableEntry(pkgName, className, memberDiff); } writeTableEnd(); } } /** * Write the start of the HTML header, together with the current * date and time in an HTML comment. */ public void writeStartHTMLHeaderWithDate() { writeStartHTMLHeader(true); } /** Write the start of the HTML header. */ public void writeStartHTMLHeader() { writeStartHTMLHeader(false); } /** Write the start of the HTML header. */ public void writeStartHTMLHeader(boolean addDate) { writeText(""); writeText(""); writeText("
"); writeText(""); writeText(""); writeText(""); if (addDate) writeText(""); writeText(""); writeText(""); } /** Write the HTML title */ public void writeHTMLTitle(String title) { writeText("| "); writeText(" ©2008 Google - "); writeText(" Code Home - "); writeText(" Site Terms of Service - "); writeText(" Privacy Policy "); writeText(" "); writeText(" | "); writeText("
![](\"../../../assets-google/android-logo-sm.gif\"){kind=logo}
");
reportFile.println(" | API Diff Specification | "); reportFile.println("|
| To Version: | "); reportFile.println("" + newAPIName + " | "); reportFile.println("
| From Version: | "); reportFile.println("" + oldAPIName + " | "); reportFile.println("
| Product Type: | "); // reportFile.println("Generic | "); // reportFile.println("
| Generated | "); reportFile.println("" + formatter.format( day ) + " | "); reportFile.println("
| Statistics"); reportFile.println(" |
");
reportFile.println("
| ");
// The right hand side title, only added at the top
if (upperNavigationBar) {
reportFile.println(" Generated by JDiff | ");
} else {
reportFile.println(" "); } reportFile.println(" | ||||||||||||||||||||
| "); // Display links to the previous and next packages or classes if (atPackage || atClass) { String elemName = "CLASS"; if (className == null) { elemName = "PACKAGE"; } if (prevElemLink == null) { reportFile.println(" PREV " + elemName + " "); } else { reportFile.println(" PREV " + elemName + ""); } if (nextElemLink == null) { reportFile.println(" NEXT " + elemName + " "); } else { reportFile.println(" NEXT " + elemName + ""); } reportFile.println(" "); } else { reportFile.println(" "); } // Links for frames and non-frames. reportFile.println(" FRAMES "); if (className == null) { if (level == 0) { reportFile.println(" NO FRAMES | "); } else { reportFile.println(" NO FRAMES"); } } else { reportFile.println(" NO FRAMES"); } // All of the details links are in one table cell if (atClass) { // Links to a class page's sections // The meaning of these three variable is overloaded boolean hasCtors = hasRemovals; boolean hasMethods = hasAdditions; boolean hasFields = hasChanges; if (hasCtors || hasMethods || hasFields) { reportFile.println("DETAIL: "); if (hasCtors) { reportFile.println("CONSTRUCTORS | "); } else { reportFile.println("CONSTRUCTORS | "); } if (hasMethods) { reportFile.println("METHODS | "); } else { reportFile.println("METHODS | "); } if (hasFields) { reportFile.println("FIELDS"); } else { reportFile.println("FIELDS"); } reportFile.println(" | "); } else { // Make the end of the table line match the length of the top reportFile.println(""); } } else { // Links to a package page's sections if (hasRemovals || hasAdditions || hasChanges) { reportFile.println(" | DETAIL: "); if (hasRemovals) { reportFile.println("REMOVED | "); } else { reportFile.println("REMOVED | "); } if (hasAdditions) { reportFile.println("ADDED | "); } else { reportFile.println("ADDED | "); } if (hasChanges) { reportFile.println("CHANGED"); } else { reportFile.println("CHANGED"); } reportFile.println(" | "); } else { // Make the end of the table line match the length of the top reportFile.println(""); } } reportFile.println(" | ||||||||||||||||||
"); // Assumes that the first word of the title categorizes the table type // and that there is a space after the first word in the title int idx = title.indexOf(' '); String namedAnchor = title.substring(0, idx); reportFile.println(""); // Named anchor reportFile.println("
| "); reportFile.println(title + ""); reportFile.println(" | "); } /** * If a class or package name is considered to be too long for convenient * display, insert
|---|
| ");
reportFile.println(" "); // Named anchor
}
//String shownPkgName = makeTwoRows(pkgName);
if (linkType == 0) {
if (oldDocPrefix == null) {
// No link
reportFile.print(" " + pkgName);
} else {
// Call this method again but this time to emit a link to the
// old program element.
writePackageTableEntry(pkgName, 1, possibleComment, true);
}
} else if (linkType == 1) {
// Link to HTML file for the package
String pkgRef = pkgName;
pkgRef = pkgRef.replace('.', '/');
if (useOld)
pkgRef = oldDocPrefix + pkgRef + "/package-summary";
else
pkgRef = newDocPrefix + pkgRef + "/package-summary";
reportFile.println(" | ");
emitComment(pkgName, possibleComment, linkType);
reportFile.println("
| ");
reportFile.println(" "); // Named anchor
}
String fqName = pkgName + "." + className;
String shownClassName = makeTwoRows(className);
if (linkType == 0) {
if (oldDocPrefix == null) {
// No link
if (isInterface)
reportFile.println(" " + shownClassName + "");
else
reportFile.println(" " + shownClassName);
} else {
writeClassTableEntry(pkgName, className,
1, isInterface,
possibleComment, true);
}
} else if (linkType == 1) {
// Link to HTML file for the class
String classRef = fqName;
// Deal with inner classes
if (className.indexOf('.') != -1) {
classRef = pkgName + ".";
classRef = classRef.replace('.', '/');
if (useOld)
classRef = oldDocPrefix + classRef + className;
else
classRef = newDocPrefix + classRef + className;
} else {
classRef = classRef.replace('.', '/');
if (useOld)
classRef = oldDocPrefix + classRef;
else
classRef = newDocPrefix + classRef;
}
reportFile.print(" | ");
emitComment(fqName, possibleComment, linkType);
reportFile.println("
| ");
reportFile.println(" "); // Named anchor
}
String shortType = simpleName(type);
if (linkType == 0) {
if (oldDocPrefix == null) {
// No link
reportFile.print(" | ");
emitComment(commentID, possibleComment, linkType);
reportFile.println("
| ");
reportFile.println(" "); // Named anchor
String memberRef = fqName.replace('.', '/');
String shownClassName = makeTwoRows(className);
// Deal with inner classes
if (className.indexOf('.') != -1) {
memberRef = pkgName + ".";
memberRef = memberRef.replace('.', '/');
memberRef = newDocPrefix + memberRef + className;
} else {
memberRef = newDocPrefix + memberRef;
}
String newType = memberDiff.newType_;
if (newType.compareTo("void") == 0)
newType = "";
String shortNewType = simpleName(memberDiff.newType_);
// Constructors have the linked name, then the type in parentheses.
reportFile.print(" | ");
// Report changes in documentation
if (reportDocChanges && memberDiff.documentationChange_ != null) {
String oldMemberRef = null;
String oldType = null;
if (oldDocPrefix != null) {
oldMemberRef = pkgName + "." + className;
oldMemberRef = oldMemberRef.replace('.', '/');
if (className.indexOf('.') != -1) {
oldMemberRef = pkgName + ".";
oldMemberRef = oldMemberRef.replace('.', '/');
oldMemberRef = oldDocPrefix + oldMemberRef + className;
} else {
oldMemberRef = oldDocPrefix + oldMemberRef;
}
oldType = memberDiff.oldType_;
if (oldType.compareTo("void") == 0)
oldType = "";
}
if (oldDocPrefix != null)
memberDiff.documentationChange_ += "old to ";
else
memberDiff.documentationChange_ += "old to ";
memberDiff.documentationChange_ += "new.
| ");
reportFile.println(" "); // Named anchor
}
if (signature.compareTo("void") == 0)
signature = "";
String shortSignature = simpleName(signature);
String returnType = methodAPI.returnType_;
String shortReturnType = simpleName(returnType);
if (linkType == 0) {
if (oldDocPrefix == null) {
// No link
reportFile.print(" | ");
emitComment(commentID, possibleComment, linkType);
reportFile.println("
| ");
reportFile.println(" "); // Named anchor
String memberRef = fqName.replace('.', '/');
// Deal with inner classes
if (className.indexOf('.') != -1) {
memberRef = pkgName + ".";
memberRef = memberRef.replace('.', '/');
memberRef = newDocPrefix + memberRef + className;
} else {
memberRef = newDocPrefix + memberRef;
}
// Javadoc generated HTML has no named anchors for methods
// inherited from other classes, so link to the defining class' method.
// Only copes with non-inner classes.
if (className.indexOf('.') == -1 &&
memberDiff.modifiersChange_ != null &&
memberDiff.modifiersChange_.indexOf("but is now inherited from") != -1) {
memberRef = memberDiff.inheritedFrom_;
memberRef = memberRef.replace('.', '/');
memberRef = newDocPrefix + memberRef;
}
String newReturnType = memberDiff.newType_;
String shortReturnType = simpleName(newReturnType);
String shortSignature = simpleName(newSignature);
reportFile.print(" | ");
// Report changes in documentation
if (reportDocChanges && memberDiff.documentationChange_ != null) {
String oldMemberRef = null;
String oldSignature = null;
if (oldDocPrefix != null) {
oldMemberRef = pkgName + "." + className;
oldMemberRef = oldMemberRef.replace('.', '/');
if (className.indexOf('.') != -1) {
oldMemberRef = pkgName + ".";
oldMemberRef = oldMemberRef.replace('.', '/');
oldMemberRef = oldDocPrefix + oldMemberRef + className;
} else {
oldMemberRef = oldDocPrefix + oldMemberRef;
}
oldSignature = memberDiff.oldSignature_;
}
if (oldDocPrefix != null)
memberDiff.documentationChange_ += "old to ";
else
memberDiff.documentationChange_ += "old to ";
memberDiff.documentationChange_ += "new.
| ");
reportFile.println(" "); // Named anchor
}
String fieldType = fieldAPI.type_;
if (fieldType.compareTo("void") == 0)
fieldType = "";
String shortFieldType = simpleName(fieldType);
if (linkType == 0) {
if (oldDocPrefix == null) {
// No link.
reportFile.print(" ");
emitType(shortFieldType);
reportFile.println(" " + fieldName);
} else {
writeFieldTableEntry(pkgName, className,
fieldAPI, 1,
possibleComment, true);
}
} else if (linkType == 1) {
// Link to HTML file for the package.
String memberRef = fqName.replace('.', '/');
// Deal with inner classes
if (className.indexOf('.') != -1) {
memberRef = pkgName + ".";
memberRef = memberRef.replace('.', '/');
if (useOld)
memberRef = oldDocPrefix + memberRef + className;
else
memberRef = newDocPrefix + memberRef + className;
} else {
if (useOld)
memberRef = oldDocPrefix + memberRef;
else
memberRef = newDocPrefix + memberRef;
}
reportFile.print(" | ");
emitComment(commentID, possibleComment, linkType);
reportFile.println("
| ");
reportFile.println(" "); // Named anchor
String memberRef = fqName.replace('.', '/');
// Deal with inner classes
if (className.indexOf('.') != -1) {
memberRef = pkgName + ".";
memberRef = memberRef.replace('.', '/');
memberRef = newDocPrefix + memberRef + className;
} else {
memberRef = newDocPrefix + memberRef;
}
// Javadoc generated HTML has no named anchors for fields
// inherited from other classes, so link to the defining class' field.
// Only copes with non-inner classes.
if (className.indexOf('.') == -1 &&
memberDiff.modifiersChange_ != null &&
memberDiff.modifiersChange_.indexOf("but is now inherited from") != -1) {
memberRef = memberDiff.inheritedFrom_;
memberRef = memberRef.replace('.', '/');
memberRef = newDocPrefix + memberRef;
}
String newType = memberDiff.newType_;
String shortNewType = simpleName(newType);
reportFile.print(" | ");
// Report changes in documentation
if (reportDocChanges && memberDiff.documentationChange_ != null) {
String oldMemberRef = null;
if (oldDocPrefix != null) {
oldMemberRef = pkgName + "." + className;
oldMemberRef = oldMemberRef.replace('.', '/');
if (className.indexOf('.') != -1) {
oldMemberRef = pkgName + ".";
oldMemberRef = oldMemberRef.replace('.', '/');
oldMemberRef = oldDocPrefix + oldMemberRef + className;
} else {
oldMemberRef = oldDocPrefix + oldMemberRef;
}
}
if (oldDocPrefix != null)
memberDiff.documentationChange_ += "old to ";
else
memberDiff.documentationChange_ += "old to ";
memberDiff.documentationChange_ += "new.");
boolean hasContent = false;
// The type or return type changed
if (memberDiff.oldType_.compareTo(memberDiff.newType_) != 0) {
String shortOldType = simpleName(memberDiff.oldType_);
String shortNewType = simpleName(memberDiff.newType_);
if (memberType == 1) {
reportFile.print("Change in return type from ");
} else {
reportFile.print("Change in type from ");
}
if (shortOldType.compareTo(shortNewType) == 0) {
// The types differ in package name, so use the full name
shortOldType = memberDiff.oldType_;
shortNewType = memberDiff.newType_;
}
emitType(shortOldType);
reportFile.print(" to ");
emitType(shortNewType);
reportFile.println(". "); hasContent = true; } // The signatures changed - only used by methods if (memberType == 1 && memberDiff.oldSignature_ != null && memberDiff.newSignature_ != null && memberDiff.oldSignature_.compareTo(memberDiff.newSignature_) != 0) { String shortOldSignature = simpleName(memberDiff.oldSignature_); String shortNewSignature = simpleName(memberDiff.newSignature_); if (shortOldSignature.compareTo(shortNewSignature) == 0) { // The signatures differ in package names, so use the full form shortOldSignature = memberDiff.oldSignature_; shortNewSignature = memberDiff.newSignature_; } if (hasContent) reportFile.print(" "); reportFile.print("Change in signature from "); if (shortOldSignature.compareTo("") == 0) shortOldSignature = "void"; emitType(shortOldSignature); reportFile.print(" to "); if (shortNewSignature.compareTo("") == 0) shortNewSignature = "void"; emitType(shortNewSignature); reportFile.println(". "); hasContent = true; } // The exceptions are only non-null in methods and constructors if (memberType != 2 && memberDiff.oldExceptions_ != null && memberDiff.newExceptions_ != null && memberDiff.oldExceptions_.compareTo(memberDiff.newExceptions_) != 0) { if (hasContent) reportFile.print(" "); // If either one of the exceptions has no spaces in it, or is // equal to "no exceptions", then just display the whole // exceptions texts. int spaceInOld = memberDiff.oldExceptions_.indexOf(" "); if (memberDiff.oldExceptions_.compareTo("no exceptions") == 0) spaceInOld = -1; int spaceInNew = memberDiff.newExceptions_.indexOf(" "); if (memberDiff.newExceptions_.compareTo("no exceptions") == 0) spaceInNew = -1; if (spaceInOld == -1 || spaceInNew == -1) { reportFile.print("Change in exceptions thrown from "); emitException(memberDiff.oldExceptions_); reportFile.print(" to " ); emitException(memberDiff.newExceptions_); reportFile.println(". "); } else { // Too many exceptions become unreadable, so just show the // individual changes. Catch the case where exceptions are // just reordered. boolean firstChange = true; int numRemoved = 0; StringTokenizer stOld = new StringTokenizer(memberDiff.oldExceptions_, ", "); while (stOld.hasMoreTokens()) { String oldException = stOld.nextToken(); if (!memberDiff.newExceptions_.startsWith(oldException) && !(memberDiff.newExceptions_.indexOf(", " + oldException) != -1)) { if (firstChange) { reportFile.print("Change in exceptions: "); firstChange = false; } if (numRemoved != 0) reportFile.print(", "); emitException(oldException); numRemoved++; } } if (numRemoved == 1) reportFile.print(" was removed."); else if (numRemoved > 1) reportFile.print(" were removed."); int numAdded = 0; StringTokenizer stNew = new StringTokenizer(memberDiff.newExceptions_, ", "); while (stNew.hasMoreTokens()) { String newException = stNew.nextToken(); if (!memberDiff.oldExceptions_.startsWith(newException) && !(memberDiff.oldExceptions_.indexOf(", " + newException) != -1)) { if (firstChange) { reportFile.print("Change in exceptions: "); firstChange = false; } if (numAdded != 0) reportFile.println(", "); else reportFile.println(" "); emitException(newException); numAdded++; } } if (numAdded == 1) reportFile.print(" was added"); else if (numAdded > 1) reportFile.print(" were added"); else if (numAdded == 0 && numRemoved == 0 && firstChange) reportFile.print("Exceptions were reordered"); reportFile.println(". "); } // Note the changes between a comma-separated list of Strings hasContent = true; } if (memberDiff.documentationChange_ != null) { if (hasContent) reportFile.print(" "); reportFile.print(memberDiff.documentationChange_); hasContent = true; } // Last, so no need for a if (memberDiff.modifiersChange_ != null) { if (hasContent) reportFile.print(" "); reportFile.println(memberDiff.modifiersChange_); hasContent = true; } reportFile.println(" | ");
}
/**
* Emit a string which is an exception by surrounding it with
* <code> tags.
* If there is a space in the type, e.g. "String, File", then
* surround it with parentheses too. Do not add <code> tags or
* parentheses if the String is "no exceptions".
*/
public void emitException(String ex) {
if (ex.compareTo("no exceptions") == 0) {
reportFile.print(ex);
} else {
if (ex.indexOf(' ') != -1) {
reportFile.print("("); return; } if (noCommentsOnAdditions && linkType == 1) { reportFile.println(" | "); return; } if (noCommentsOnChanges && linkType == 2) { reportFile.println(" | "); return; } // We have to use this global hash table because the *Diff classes // do not store the possible comment from the new *API object. if (!noCommentsOnChanges && possibleComment == null) { possibleComment = (String)Comments.allPossibleComments.get(commentID); } // Just use the first sentence of the possible comment. if (possibleComment != null) { int fsidx = RootDocToXML.endOfFirstSentence(possibleComment, false); if (fsidx != -1 && fsidx != 0) possibleComment = possibleComment.substring(0, fsidx+1); } String comment = Comments.getComment(existingComments_, commentID); if (comment.compareTo(Comments.placeHolderText) == 0) { if (possibleComment != null && possibleComment.indexOf("InsertOtherCommentsHere") == -1) reportFile.println(" | " + possibleComment + " | "); else reportFile.println(""); } else { int idx = comment.indexOf("@first"); if (idx == -1) { reportFile.println(" | " + Comments.convertAtLinks(comment, "", null, null) + " | "); } else { reportFile.print("" + comment.substring(0, idx)); if (possibleComment != null && possibleComment.indexOf("InsertOtherCommentsHere") == -1) reportFile.print(possibleComment); reportFile.println(comment.substring(idx + 6) + " | "); } } SingleComment newComment = new SingleComment(commentID, comment); newComments_.addComment(newComment); } /** Write the end of a table. */ public void writeTableEnd() { reportFile.println("
![](\"../../../assets/jdiff_logo.gif\"){kind=logo}
");
writeText(" ");
writeText("