JAVA-2560 : Use jdk.javadoc.doclet package

This change adds a requirement that a minimum of Java 9 is used to build
the driver, as the jdk.javadoc.doclet package was introduced in Java 9.

Author: fhassak

.travis.yml

@@ -2,7 +2,7 @@ dist: trusty
 sudo: true
 language: java
 jdk:
-- oraclejdk8
+- oraclejdk9
 
 notifications:
   email:
@@ -38,6 +38,7 @@ before_script:
 script:
   - ./gradlew -q assemble
   - ./gradlew check -Ptravistest=true
+  - ./gradlew docs
 
 after_script:
   - pkill mongod

CONTRIBUTING.md

@@ -17,12 +17,12 @@ Pull Requests
 
 Pull requests should generally be made against the master (default) branch and include relevant tests, if applicable. 
 
-Code should compile and tests should pass under all Java versions which the driver currently supports.  Currently the Java driver 
-supports a minimum version of Java 6.  Please run './gradlew test' to confirm.   By default, running the tests requires that you started a 
-mongod server on localhost, listening on the default port and configured to run with
+Code should compile with a Java 9 or later `javac` executable and tests should pass under all Java versions which the driver currently
+supports. Currently the Java driver supports a minimum version of Java 6.  Please run './gradlew test' to confirm.   By default, running the
+tests requires that you start a mongod server on localhost, listening on the default port and configured to run with
 [`enableTestCommands`](http://docs.mongodb.org/manual/reference/parameters/#param.enableTestCommands), which may be set with the 
 `--setParameter enableTestCommands=1` command-line parameter.   At minimum, please test against the latest release version of the MongoDB 
-server.
+server and the latest version of Java currently available.
 
 The results of pull request testing will be appended to the request. If any tests do not pass, or relevant tests are not included, the 
 pull request will not be considered. 

build.gradle

@@ -282,14 +282,16 @@ task docs(type: Javadoc) {
 def setJavaDocOptions(MinimalJavadocOptions options) {
     options.author = true
     options.version = true
-    options.links 'http://docs.oracle.com/javase/7/docs/api/'
+    options.links 'https://docs.oracle.com/javase/9/docs/api/'
     options.tagletPath single(project(':util').sourceSets.main.output.classesDirs)
     options.taglets 'ManualTaglet'
     options.taglets 'DochubTaglet'
     options.taglets 'ServerReleaseTaglet'
     options.encoding = 'UTF-8'
     options.charSet 'UTF-8'
     options.docEncoding 'UTF-8'
+    options.addBooleanOption("html4", true)
+    options.addBooleanOption("-allow-script-in-comments", true)
     options.header = '''
             <script type="text/javascript">
             <!-- Set the location hash in the classFrame -->
@@ -312,15 +314,6 @@ def setJavaDocOptions(MinimalJavadocOptions options) {
             }
             </script>
         '''
-
-    // Add --allow-script-in-comments if available (since 1.8.0_121)
-    try {
-        if (Class.forName('com.sun.tools.doclets.formats.html.ConfigurationImpl')
-                .newInstance().optionLength('--allow-script-in-comments') > 0) {
-            options.addBooleanOption("-allow-script-in-comments", true)
-        }
-    } catch (ignored) {
-    }
 }
 
 //////////////////////////////////////////
@@ -331,8 +324,8 @@ task wrapper(type: Wrapper) {
 }
 
 gradle.buildFinished { BuildResult result ->
-    if (result.failure && !JavaVersion.current().isJava8Compatible()) {
-        gradle.rootProject.logger.error("\nWARNING:\nJDK ${JavaVersion.VERSION_1_8} is required to build the driver: " +
+    if (result.failure && !JavaVersion.current().isJava9Compatible()) {
+        gradle.rootProject.logger.error("\nWARNING:\nJDK ${JavaVersion.VERSION_1_9} is required to build the driver: " +
                 "you are using JDK ${JavaVersion.current()}.")
     }
 }

driver-core/src/main/com/mongodb/client/model/Projections.java

@@ -185,7 +185,6 @@ public static Bson fields(final Bson... projections) {
      *
      * @param projections the list of projections to combine
      * @return the combined projection
-     * @mongodb.driver.manual
      */
     public static Bson fields(final List<? extends Bson> projections) {
         notNull("sorts", projections);

util/build.gradle

@@ -16,12 +16,8 @@
 
 apply plugin: 'java'
 
-sourceCompatibility = '1.6'
-targetCompatibility = '1.6'
-
-dependencies {
-    compile files("${System.getProperty('java.home')}/../lib/tools.jar")
-}
+sourceCompatibility = JavaVersion.VERSION_1_6
+targetCompatibility = JavaVersion.VERSION_1_6
 
 sourceSets {
     main { java.srcDirs = ['src/main'] }

util/src/main/DocTaglet.java

@@ -14,57 +14,43 @@
  * limitations under the License.
  */
 
-import com.sun.javadoc.Tag;
-import com.sun.tools.doclets.Taglet;
+import com.sun.source.doctree.DocTree;
+import com.sun.source.doctree.UnknownBlockTagTree;
+import jdk.javadoc.doclet.Taglet;
+import javax.lang.model.element.Element;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
-public abstract class DocTaglet implements Taglet {
-
-    public boolean inConstructor() {
-        return true;
-    }
-
-    public boolean inField() {
-        return true;
-    }
-
-    public boolean inMethod() {
-        return true;
-    }
-
-    public boolean inOverview() {
-        return true;
-    }
+import static java.util.Arrays.asList;
+import static jdk.javadoc.doclet.Taglet.Location.*;
 
-    public boolean inPackage() {
-        return true;
-    }
+public abstract class DocTaglet implements Taglet {
 
-    public boolean inType() {
-        return true;
+    @Override
+    public Set<Location> getAllowedLocations() {
+        return new HashSet<Location>(asList(CONSTRUCTOR, METHOD, FIELD, OVERVIEW, PACKAGE, TYPE));
     }
 
+    @Override
     public boolean isInlineTag() {
         return false;
     }
 
-    public String toString(final Tag[] tags) {
-        if (tags.length == 0) {
+    @Override
+    public String toString(List<? extends DocTree> tags, Element element) {
+        if (tags.size() == 0) {
             return null;
         }
 
         StringBuilder buf = new StringBuilder(String.format("<dl><dt><span class=\"strong\">%s</span></dt>", getHeader()));
-        for (Tag t : tags) {
-            buf.append("<dd>").append(genLink(t.text())).append("</dd>");
+        for (DocTree tag : tags) {
+            String text = ((UnknownBlockTagTree) tag).getContent().get(0).toString();
+            buf.append("<dd>").append(genLink(text)).append("</dd>");
         }
         return buf.toString();
     }
 
-    protected abstract String getHeader();
-
-    public String toString(final Tag tag) {
-        return toString(new Tag[]{tag});
-    }
-
     protected String genLink(final String text) {
         String relativePath = text;
         String display = text;
@@ -78,5 +64,7 @@ protected String genLink(final String text) {
         return String.format("<a href='%s%s'>%s</a>", getBaseDocURI(), relativePath, display);
     }
 
+    protected abstract String getHeader();
+
     protected abstract String getBaseDocURI();
 }

util/src/main/DochubTaglet.java

@@ -14,17 +14,9 @@
  * limitations under the License.
  */
 
-import com.sun.tools.doclets.Taglet;
-
-import java.util.Map;
-
 public class DochubTaglet extends DocTaglet {
 
-    public static void register(final Map<String, Taglet> tagletMap) {
-        DochubTaglet t = new DochubTaglet();
-        tagletMap.put(t.getName(), t);
-    }
-
+    @Override
     public String getName() {
         return "mongodb.driver.dochub";
     }

util/src/main/ManualTaglet.java

@@ -14,17 +14,9 @@
  * limitations under the License.
  */
 
-import com.sun.tools.doclets.Taglet;
-
-import java.util.Map;
-
 public class ManualTaglet extends DocTaglet {
 
-    public static void register(final Map<String, Taglet> tagletMap) {
-        ManualTaglet t = new ManualTaglet();
-        tagletMap.put(t.getName(), t);
-    }
-
+    @Override
     public String getName() {
         return "mongodb.driver.manual";
     }

util/src/main/ServerReleaseTaglet.java

@@ -14,29 +14,21 @@
  * limitations under the License.
  */
 
-import com.sun.tools.doclets.Taglet;
-
-import java.util.Map;
-
 public class ServerReleaseTaglet extends DocTaglet {
 
-    public static void register(final Map<String, Taglet> tagletMap) {
-        Taglet t = new ServerReleaseTaglet();
-        tagletMap.put(t.getName(), t);
-    }
-
     @Override
     public String getName() {
         return "mongodb.server.release";
     }
 
     @Override
-    protected String getBaseDocURI() {
-        return "http://docs.mongodb.org/manual/release-notes/";
+    protected String getHeader() {
+        return "Since server release";
     }
 
     @Override
-    protected String getHeader() {
-        return "Since server release";
+    protected String getBaseDocURI() {
+        return "http://docs.mongodb.org/manual/release-notes/";
     }
+
 }