1 /*

     2  * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.

     8  *

     9  * This code is distributed in the hope that it will be useful, but WITHOUT

    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    12  * version 2 for more details (a copy is included in the LICENSE file that

    13  * accompanied this code).

    14  *

    15  * You should have received a copy of the GNU General Public License version

    16  * 2 along with this work; if not, write to the Free Software Foundation,

    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    18  *

    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    20  * or visit www.oracle.com if you need additional information or have any

    21  * questions.

    22  */

    23 

    24 /*

    25  * @test

    26  * @bug 4959985

    27  * @summary Verify that (verbose) warnings are no longer generated when

    28  *          the default first-sentence algorithm doesn't match the

    29  *          BreakIterator algorithm.

    30  * @modules jdk.javadoc

    31  */

    32 

    33 import java.util.ArrayList;

    34 import java.util.Collections;

    35 import java.util.List;

    36 import java.util.Locale;

    37 import java.util.Set;

    38 

    39 import javax.lang.model.SourceVersion;

    40 import javax.lang.model.element.ElementKind;

    41 import javax.lang.model.element.TypeElement;

    42 import javax.lang.model.element.VariableElement;

    43 

    44 import com.sun.source.doctree.DocCommentTree;

    45 import com.sun.source.doctree.DocTree;

    46 import com.sun.source.util.DocTrees;

    47 import jdk.javadoc.doclet.Doclet;

    48 import jdk.javadoc.doclet.Reporter;

    49 import jdk.javadoc.doclet.DocletEnvironment;

    50 

    51 public class BreakIteratorWarning implements Doclet {

    52 

    53     public static void main(String[] args) {

    54         String thisFile = "" +

    55             new java.io.File(System.getProperty("test.src", "."),

    56                              "BreakIteratorWarning.java");

    57 

    58         String[] argarray = {

    59             "-docletpath", System.getProperty("test.classes", "."),

    60             "-doclet", "BreakIteratorWarning",

    61             "-Xwerror",

    62             thisFile

    63         };

    64         if (jdk.javadoc.internal.tool.Main.execute(argarray) != 0)

    65             throw new Error("Javadoc encountered warnings or errors.");

    66     }

    67 

    68     List<VariableElement> getFields(TypeElement klass) {

    69         List<VariableElement> fields = new ArrayList<>();

    70         klass.getEnclosedElements()

    71                 .stream()

    72                 .filter((e) -> (e.getKind() == ElementKind.FIELD))

    73                 .forEach((e) -> { fields.add((VariableElement)e);});

    74         return fields;

    75     }

    76 

    77     public boolean run(DocletEnvironment root) {

    78         TypeElement cd = root.getIncludedClasses().iterator().next();

    79         VariableElement fd = getFields(cd).get(0);

    80         DocTrees docTrees = root.getDocTrees();

    81         DocCommentTree docCommentTree = docTrees.getDocCommentTree(fd);

    82         List<? extends DocTree> firstSentence = docCommentTree.getFirstSentence();

    83         return true;

    84     }

    85 

    86 

    87     /**

    88      * "He'll never catch up!" the Sicilian cried.  "Inconceivable!"

    89      * "You keep using that word!" the Spaniard snapped.  "I do not

    90      * think it means what you think it means."

    91      *

    92      * <p> This comment used to trigger a warning, but no longer does.

    93      */

    94     public String author = "William Goldman";

    95 

    96     @Override

    97     public String getName() {

    98         return "Test";

    99     }

   100 

   101     @Override

   102     public Set<Option> getSupportedOptions() {

   103         return Collections.emptySet();

   104     }

   105 

   106     @Override

   107     public SourceVersion getSupportedSourceVersion() {

   108         return SourceVersion.latest();

   109     }

   110 

   111     public void init(Locale locale, Reporter reporter) {

   112         return;

   113     }

   114 }