close in interface java.lang.AutoCloseableclose in interface java.nio.channels.Channelclose in interface java.io.Closeableiterator in interface java.util.Collection<",
"iterator in interface java.lang.Iterable<");
}
void checkClassUseOrdering(String usePage) {
checkClassUseOrdering(usePage, "C#ITERATION#.html#zfield");
checkClassUseOrdering(usePage, "C#ITERATION#.html#fieldInC#ITERATION#");
checkClassUseOrdering(usePage, "C#ITERATION#.html#zmethod(pkg1.UsedClass");
checkClassUseOrdering(usePage, "C#ITERATION#.html#methodInC#ITERATION#");
}
void checkClassUseOrdering(String usePage, String searchString) {
String contents = readFile(usePage);
int lastidx = 0;
System.out.println("testing for " + searchString);
for (int i = 1; i < 5; i++) {
String s = searchString.replaceAll("#ITERATION#", Integer.toString(i));
checking(s);
int idx = contents.indexOf(s);
if (idx < lastidx) {
failed(s + ", member ordering error, last:" + lastidx + ", got:" + idx);
} else {
passed("\tlast: " + lastidx + " got:" + idx);
}
lastidx = idx;
}
}
}
enum ListOrder {
NONE, REVERSE, SHUFFLE
};
class IndexOrderingTest {
/*
* By default we do not shuffle the input list, in order to keep the list deterministic,
* and the test predictable. However, we can turn on the stress mode, by setting the following
* property if required.
*/
final ListOrder STRESS_MODE = Boolean.getBoolean("TestOrder.STRESS")
? ListOrder.SHUFFLE
: ListOrder.REVERSE;
/*
* Controls the number of children packages, pkg0, pkg0.pkg, pkg0.pkg.pkg, .....
* Note: having too long a depth (> 256 chars on Windows), will likely lead to
* cause problems with automated build and test systems.
*/
static final int MAX_SUBPACKAGES_DEPTH = 4;
/*
* Controls the number of sibling packages, pkg0, pkg1, pkg2, .....
*/
static final int MAX_PACKAGES = 4;
String[] contents = {
"public add ADDADD;",
"public add AddAdd;",
"public add addadd;",
"public enum add {add, ADD, addd, ADDD};",
"public enum ADD {ADD, add, addd, ADDD};",
"public void add(){}",
"public void add(double d){}",
"public void add(int i, float f){}",
"public void add(float f, int i){}",
"public void add(double d, byte b){}",
"public Double add(Double d) {return (double) 22/7;}",
"public double add(double d1, double d2) {return d1 + d2;}",
"public double add(double d1, Double d2) {return d1 + d2;}",
"public Float add(float f) {return (float) 22/7;}",
"public void add(int i){}",
"public int add(Integer i) {return 0;}"
};
String expectedEnumOrdering[] = {
"""
Add.add.html" title="enum class in REPLACE_ME\"""",
"""
Add.ADD.html" title="enum class in REPLACE_ME\""""
};
String expectedFieldOrdering[] = {
"Add.html#addadd\"",
"""
add0/add/add/add/Add.html#addadd\"""",
"add0/add/add/Add.html#addadd\"",
"add0/add/Add.html#addadd\"",
"add0/Add.html#addadd\"",
"""
add1/add/add/add/Add.html#addadd\"""",
"add1/add/add/Add.html#addadd\"",
"add1/add/Add.html#addadd\"",
"add1/Add.html#addadd\"",
"""
add2/add/add/add/Add.html#addadd\"""",
"add2/add/add/Add.html#addadd\"",
"add2/add/Add.html#addadd\"",
"add2/Add.html#addadd\"",
"""
add3/add/add/add/Add.html#addadd\"""",
"add3/add/add/Add.html#addadd\"",
"add3/add/Add.html#addadd\"",
"add3/Add.html#addadd\"",
"Add.html#AddAdd\"",
"""
add0/add/add/add/Add.html#AddAdd\"""",
"add0/add/add/Add.html#AddAdd\"",
"add0/add/Add.html#AddAdd\"",
"add0/Add.html#AddAdd\"",
"""
add1/add/add/add/Add.html#AddAdd\"""",
"add1/add/add/Add.html#AddAdd\"",
"add1/add/Add.html#AddAdd\"",
"add1/Add.html#AddAdd\"",
"""
add2/add/add/add/Add.html#AddAdd\"""",
"add2/add/add/Add.html#AddAdd\"",
"add2/add/Add.html#AddAdd\"",
"add2/Add.html#AddAdd\"",
"""
add3/add/add/add/Add.html#AddAdd\"""",
"add3/add/add/Add.html#AddAdd\"",
"add3/add/Add.html#AddAdd\"",
"add3/Add.html#AddAdd\"",
"Add.html#ADDADD\"",
"""
add0/add/add/add/Add.html#ADDADD\"""",
"add0/add/add/Add.html#ADDADD\"",
"add0/add/Add.html#ADDADD\"",
"add0/Add.html#ADDADD\"",
"""
add1/add/add/add/Add.html#ADDADD\"""",
"add1/add/add/Add.html#ADDADD\"",
"add1/add/Add.html#ADDADD\"",
"add1/Add.html#ADDADD\"",
"""
add2/add/add/add/Add.html#ADDADD\"""",
"add2/add/add/Add.html#ADDADD\"",
"add2/add/Add.html#ADDADD\"",
"add2/Add.html#ADDADD\"",
"""
add3/add/add/add/Add.html#ADDADD\"""",
"add3/add/add/Add.html#ADDADD\"",
"add3/add/Add.html#ADDADD\"",
"add3/Add.html#ADDADD\""
};
String expectedMethodOrdering[] = {
"Add.html#add()",
"Add.html#add(double)",
"Add.html#add(double,byte)",
"Add.html#add(double,double)",
"Add.html#add(double,java.lang.Double)",
"Add.html#add(float)",
"Add.html#add(float,int)",
"Add.html#add(int)",
"Add.html#add(int,float)",
"Add.html#add(java.lang.Double)",
"Add.html#add(java.lang.Integer)"
};
String expectedPackageOrdering[] = {
"""
"add0/package-summary.html">add0 - package add0""",
"""
"add0/add/package-summary.html">add0.add - package add0.add""",
"""
"add0/add/add/package-summary.html">add0.add.add - package add0.add.add""",
"""
"add0/add/add/add/package-summary.html">add0.add.add.add - package add0.add.add.add""",
"""
"add1/package-summary.html">add1 - package add1""",
"""
"add1/add/package-summary.html">add1.add - package add1.add""",
"""
"add1/add/add/package-summary.html">add1.add.add - package add1.add.add""",
"""
"add1/add/add/add/package-summary.html">add1.add.add.add - package add1.add.add.add""",
"""
"add2/package-summary.html">add2 - package add2""",
"""
"add2/add/package-summary.html">add2.add - package add2.add""",
"""
"add2/add/add/package-summary.html">add2.add.add - package add2.add.add""",
"""
"add2/add/add/add/package-summary.html">add2.add.add.add - package add2.add.add.add""",
"""
"add3/package-summary.html">add3 - package add3""",
"""
"add3/add/package-summary.html">add3.add - package add3.add""",
"""
"add3/add/add/package-summary.html">add3.add.add - package add3.add.add""",
"""
"add3/add/add/add/package-summary.html">add3.add.add.add - package add3.add.add.add"""
};
void run() throws IOException {
final String clsname = "Add";
List cmdArgs = new ArrayList();
cmdArgs.add("-d");
cmdArgs.add("out-2");
cmdArgs.add("-sourcepath");
cmdArgs.add("src");
cmdArgs.add("-package");
System.out.println("STRESS_MODE: " + STRESS_MODE);
emitFile(null, clsname, STRESS_MODE);
for (int width = 0; width < MAX_PACKAGES; width++) {
String wpkgname = "add" + width;
String dpkgname = wpkgname;
emitFile(wpkgname, clsname, ListOrder.NONE); // list as-is
cmdArgs.add(wpkgname);
for (int depth = 1; depth < MAX_SUBPACKAGES_DEPTH; depth++) {
dpkgname = dpkgname + ".add";
emitFile(dpkgname, clsname, STRESS_MODE);
cmdArgs.add(dpkgname);
}
}
File srcDir = new File(new File("."), "src");
cmdArgs.add(new File(srcDir, clsname + ".java").getPath());
javadoc(cmdArgs.toArray(new String[cmdArgs.size()]));
checkExit(Exit.OK);
checkOrder("index-all.html", composeTestVectors());
checkOrder("add0/add/package-tree.html",
"""
""",
"""
""");
checkOrder("overview-tree.html",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""",
"""
""");
}
void emitFile(String pkgname, String clsname, ListOrder order) throws IOException {
File srcDir = new File("src");
File outDir = pkgname == null
? srcDir
: new File(srcDir, pkgname.replace(".", File.separator));
File outFile = new File(outDir, clsname + ".java");
outDir.mkdirs();
List scratch = new ArrayList<>(Arrays.asList(contents));
switch (order) {
case SHUFFLE:
Collections.shuffle(scratch);
break;
case REVERSE:
Collections.reverse(scratch);
break;
default:
// leave list as-is
}
// insert the header
scratch.add(0, "public class " + clsname + " {");
if (pkgname != null) {
scratch.add(0, "package " + pkgname + ";");
}
// append the footer
scratch.add("}");
Files.write(outFile.toPath(), scratch, CREATE, TRUNCATE_EXISTING);
}
String[] composeTestVectors() {
List testList = new ArrayList<>();
for (String x : expectedEnumOrdering) {
testList.add(x.replace("REPLACE_ME", "Unnamed Package"));
}
for (int i = 0; i < MAX_PACKAGES; i++) {
String wpkg = "add" + i;
for (String x : expectedEnumOrdering) {
testList.add(wpkg + "/" + x.replace("REPLACE_ME", wpkg));
}
String dpkg = wpkg;
for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) {
dpkg = dpkg + "/" + "add";
for (String x : expectedEnumOrdering) {
testList.add(dpkg + "/" + x.replace("REPLACE_ME", pathToPackage(dpkg)));
}
}
}
for (String x : expectedMethodOrdering) {
testList.add(x);
for (int i = 0; i < MAX_PACKAGES; i++) {
String wpkg = "add" + i;
testList.add(wpkg + "/" + x);
String dpkg = wpkg;
for (int j = 1; j < MAX_SUBPACKAGES_DEPTH; j++) {
dpkg = dpkg + "/" + "add";
testList.add(dpkg + "/" + x);
}
}
}
testList.addAll(Arrays.asList(expectedPackageOrdering));
testList.addAll(Arrays.asList(expectedFieldOrdering));
return testList.toArray(new String[testList.size()]);
}
String pathToPackage(String in) {
return in.replace("/", ".");
}
}
class IndexTypeClusteringTest {
void run() {
javadoc("-d", "out-3",
"-sourcepath", testSrc("src-2"),
"-use",
"a",
"b",
"e",
"something");
checkExit(Exit.OK);
checkOrder("index-all.html",
"something - package something",
"something - Class in",
"something - Enum Class in",
"something - Interface in",
"something - Annotation Interface in",
"something - Variable in class",
"something() - Constructor",
"something() - Method in class a. - Method in class a. - Method in class something.Field Details",
"""
static final <\
span class="return-type">int one""",
"""
static final <\
span class="return-type">int two""",
"""
static final <\
span class="return-type">int three""",
"""
static final <\
span class="return-type">int four""");
checkOrder("pkg5/AnnoOptionalTest.html",
"Optional Element Summary
",
"four",
"one",
"three",
"two",
"Element Details
",
"one
",
"two
",
"three
",
"four
");
checkOrder("pkg5/AnnoRequiredTest.html",
"Required Element Summary
",
"four",
"one",
"three",
"two",
"Element Details
",
"one
",
"two
",
"three
",
"four
");
checkOrder("pkg5/CtorTest.html",
"Constructor Summary
",
"Constructor Details",
"""
""",
"""
""",
"""
""",
"""
""");
checkOrder("pkg5/EnumTest.html",
"Enum Constant Summary
",
"FOUR",
"ONE",
"THREE",
"TWO",
"Enum Constant Details
",
"ONE
",
"TWO
",
"THREE
",
"FOUR
");
checkOrder("pkg5/FieldTest.html",
"Field Summary
",
"four",
"one",
"three",
"two",
"Field Details
",
"one
",
"two
",
"three
",
"four
");
checkOrder("pkg5/IntfTest.html",
"Method Summary
",
"four",
"one",
"three",
"two",
"Method Details
",
"one
",
"two
",
"three
",
"four
");
checkOrder("pkg5/MethodTest.html",
"Method Summary
",
"four",
"one",
"three",
"two",
"Method Details
",
"one
",
"two
",
"three
",
"four
");
checkOrder("pkg5/PropertyTest.html",
"Property Summary
",
"four",
"one",
"three",
"two",
"Property Details
",
"oneProperty
",
"twoProperty
",
"threeProperty
",
"fourProperty
");
}
}
}