exclude private and package-private classes during documentation (#36)

anmeng10101 · anmeng10101 · commit 6584b8d2a834 · 2020-06-05T15:00:52.000+08:00
diff --git a/src/main/java/com/microsoft/build/YmlFilesBuilder.java b/src/main/java/com/microsoft/build/YmlFilesBuilder.java
@@ -286,7 +286,7 @@ void addSuperclassAndInterfacesReferences(TypeElement classElement, MetadataFile
 
     void addInnerClassesReferences(TypeElement classElement, MetadataFile classMetadataFile) {
         classMetadataFile.getReferences().addAll(
-                ElementFilter.typesIn(classElement.getEnclosedElements()).stream()
+                ElementFilter.typesIn(elementUtil.extractSortedElements(classElement)).stream()
                         .map(this::buildClassReference)
                         .collect(Collectors.toList()));
     }
diff --git a/src/main/java/com/microsoft/util/ElementUtil.java b/src/main/java/com/microsoft/util/ElementUtil.java
@@ -28,7 +28,10 @@ public ElementUtil(String[] excludePackages, String[] excludeClasses) {
 
     public List<TypeElement> extractSortedElements(Element element) {
         // Need to apply sorting, because order of result items for Element.getEnclosedElements() depend on JDK implementation
+        // By default, exclude private and package-private items
+        // todo allow pass parameter for filter items by access modifiers
         return ElementFilter.typesIn(element.getEnclosedElements()).stream()
+            .filter(o -> !isPrivateOrPackagePrivate(o))
             .filter(o -> !matchAnyPattern(excludeClasses, String.valueOf(o.getQualifiedName())))
             .sorted((o1, o2) ->
                 StringUtils.compare(String.valueOf(o1.getSimpleName()), String.valueOf(o2.getSimpleName()))
diff --git a/src/test/java/com/microsoft/samples/subpackage/CustomException.java b/src/test/java/com/microsoft/samples/subpackage/CustomException.java
@@ -14,4 +14,8 @@ public CustomException(String message) {
     public void makeSomething() throws CustomException {
         throw new CustomException("It happened!");
     }
+
+    private class PrivateException {
+        private String message;
+    }
 }
diff --git a/src/test/java/com/microsoft/samples/subpackage/InternalException.java b/src/test/java/com/microsoft/samples/subpackage/InternalException.java
@@ -0,0 +1,8 @@
+package com.microsoft.samples.subpackage;
+
+class InternalException extends Exception {
+
+    public InternalException(String message) {
+        super(message);
+    }
+}
diff --git a/src/test/java/com/microsoft/util/ElementUtilTest.java b/src/test/java/com/microsoft/util/ElementUtilTest.java
@@ -55,13 +55,23 @@ public void extractPackageElements() {
     public void extractSortedElements() {
         Element element = elements.getPackageElement("com.microsoft.samples.subpackage");
 
-        List<String> result = elementUtil.extractSortedElements(element)
+        List<String> allElements = element.getEnclosedElements()
+                .stream().map(String::valueOf).collect(Collectors.toList());
+
+        // Ensure items to exclude exist.
+        assertThat("Wrong enclosed elements number", allElements.size(), is(6));
+        assertTrue("Unexpected package private class", allElements.contains("com.microsoft.samples.subpackage.InternalException"));
+        assertTrue("Unexpected to-exclude class", allElements.contains("com.microsoft.samples.subpackage.SomeExcludedClass"));
+
+
+        List<String> extractedElements = elementUtil.extractSortedElements(element)
             .stream().map(String::valueOf).collect(Collectors.toList());
 
-        assertThat("Wrong result list size", result.size(), is(4));
-        assertThat("Unexpected first item", result.get(0), is("com.microsoft.samples.subpackage.CustomException"));
-        assertThat("Unexpected second item", result.get(1), is("com.microsoft.samples.subpackage.Display"));
-        assertThat("Unexpected third item", result.get(2), is("com.microsoft.samples.subpackage.Person"));
+        // Verify filtered and sorted result
+        assertThat("Wrong result list size", extractedElements.size(), is(4));
+        assertThat("Unexpected first item in the result list after invoke method extractSortedElements()", extractedElements.get(0), is("com.microsoft.samples.subpackage.CustomException"));
+        assertThat("Unexpected second item in the result list after invoke method extractSortedElements()", extractedElements.get(1), is("com.microsoft.samples.subpackage.Display"));
+        assertThat("Unexpected third item in the result list after invoke method extractSortedElements()", extractedElements.get(2), is("com.microsoft.samples.subpackage.Person"));
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ void addSuperclassAndInterfacesReferences(TypeElement classElement, MetadataFile`
`286`	`286`
`287`	`287`	`void addInnerClassesReferences(TypeElement classElement, MetadataFile classMetadataFile) {`
`288`	`288`	`classMetadataFile.getReferences().addAll(`
`289`		`- ElementFilter.typesIn(classElement.getEnclosedElements()).stream()`
	`289`	`+ ElementFilter.typesIn(elementUtil.extractSortedElements(classElement)).stream()`
`290`	`290`	`.map(this::buildClassReference)`
`291`	`291`	`.collect(Collectors.toList()));`
`292`	`292`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,8 @@ public CustomException(String message) {`
`14`	`14`	`public void makeSomething() throws CustomException {`
`15`	`15`	`throw new CustomException("It happened!");`
`16`	`16`	`}`
	`17`	`+`
	`18`	`+ private class PrivateException {`
	`19`	`+ private String message;`
	`20`	`+ }`
`17`	`21`	`}`