langtools/test/jdk/javadoc/tool/BreakIteratorWarning.java
changeset 35426 374342e56a56
parent 30730 d3ce7619db2c
child 36526 3b41f1c69604
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/tool/BreakIteratorWarning.java	Sat Nov 28 18:52:17 2015 -0800
@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 4959985
+ * @summary Verify that (verbose) warnings are no longer generated when
+ *          the default first-sentence algorithm doesn't match the
+ *          BreakIterator algorithm.
+ * @modules jdk.javadoc
+ */
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Locale;
+import java.util.Set;
+
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.ElementKind;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.element.VariableElement;
+
+import com.sun.source.doctree.DocCommentTree;
+import com.sun.source.doctree.DocTree;
+import com.sun.source.util.DocTrees;
+import jdk.javadoc.doclet.Doclet;
+import jdk.javadoc.doclet.Reporter;
+import jdk.javadoc.doclet.DocletEnvironment;
+
+public class BreakIteratorWarning implements Doclet {
+
+    public static void main(String[] args) {
+        String thisFile = "" +
+            new java.io.File(System.getProperty("test.src", "."),
+                             "BreakIteratorWarning.java");
+
+        String[] argarray = {
+            "-docletpath", System.getProperty("test.classes", "."),
+            "-doclet", "BreakIteratorWarning",
+            "-Xwerror",
+            thisFile
+        };
+        if (jdk.javadoc.internal.tool.Main.execute(argarray) != 0)
+            throw new Error("Javadoc encountered warnings or errors.");
+    }
+
+    List<VariableElement> getFields(TypeElement klass) {
+        List<VariableElement> fields = new ArrayList<>();
+        klass.getEnclosedElements()
+                .stream()
+                .filter((e) -> (e.getKind() == ElementKind.FIELD))
+                .forEach((e) -> { fields.add((VariableElement)e);});
+        return fields;
+    }
+
+    public boolean run(DocletEnvironment root) {
+        TypeElement cd = root.getIncludedClasses().iterator().next();
+        VariableElement fd = getFields(cd).get(0);
+        DocTrees docTrees = root.getDocTrees();
+        DocCommentTree docCommentTree = docTrees.getDocCommentTree(fd);
+        List<? extends DocTree> firstSentence = docCommentTree.getFirstSentence();
+        return true;
+    }
+
+
+    /**
+     * "He'll never catch up!" the Sicilian cried.  "Inconceivable!"
+     * "You keep using that word!" the Spaniard snapped.  "I do not
+     * think it means what you think it means."
+     *
+     * <p> This comment used to trigger a warning, but no longer does.
+     */
+    public String author = "William Goldman";
+
+    @Override
+    public String getName() {
+        return "Test";
+    }
+
+    @Override
+    public Set<Option> getSupportedOptions() {
+        return Collections.emptySet();
+    }
+
+    @Override
+    public SourceVersion getSupportedSourceVersion() {
+        return SourceVersion.latest();
+    }
+
+    public void init(Locale locale, Reporter reporter) {
+        return;
+    }
+}