1/* 2 * Copyright (c) 2003, 2016, 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/jdk.javadoc.internal.tool 31 */ 32 33import java.util.ArrayList; 34import java.util.Collections; 35import java.util.List; 36import java.util.Locale; 37import java.util.Set; 38 39import javax.lang.model.SourceVersion; 40import javax.lang.model.element.ElementKind; 41import javax.lang.model.element.TypeElement; 42import javax.lang.model.element.VariableElement; 43import javax.lang.model.util.ElementFilter; 44 45import com.sun.source.doctree.DocCommentTree; 46import com.sun.source.doctree.DocTree; 47import com.sun.source.util.DocTrees; 48import jdk.javadoc.doclet.Doclet; 49import jdk.javadoc.doclet.Reporter; 50import jdk.javadoc.doclet.DocletEnvironment; 51 52public class BreakIteratorWarning implements Doclet { 53 54 public static void main(String[] args) { 55 String thisFile = "" + 56 new java.io.File(System.getProperty("test.src", "."), 57 "BreakIteratorWarning.java"); 58 59 String[] argarray = { 60 "-docletpath", System.getProperty("test.classes", "."), 61 "-doclet", "BreakIteratorWarning", 62 "-Xwerror", 63 thisFile 64 }; 65 if (jdk.javadoc.internal.tool.Main.execute(argarray) != 0) 66 throw new Error("Javadoc encountered warnings or errors."); 67 } 68 69 List<VariableElement> getFields(TypeElement klass) { 70 List<VariableElement> fields = new ArrayList<>(); 71 klass.getEnclosedElements() 72 .stream() 73 .filter((e) -> (e.getKind() == ElementKind.FIELD)) 74 .forEach((e) -> { fields.add((VariableElement)e);}); 75 return fields; 76 } 77 78 public boolean run(DocletEnvironment root) { 79 TypeElement cd = ElementFilter.typesIn(root.getIncludedElements()).iterator().next(); 80 VariableElement fd = getFields(cd).get(0); 81 DocTrees docTrees = root.getDocTrees(); 82 DocCommentTree docCommentTree = docTrees.getDocCommentTree(fd); 83 List<? extends DocTree> firstSentence = docCommentTree.getFirstSentence(); 84 return true; 85 } 86 87 88 /** 89 * "He'll never catch up!" the Sicilian cried. "Inconceivable!" 90 * "You keep using that word!" the Spaniard snapped. "I do not 91 * think it means what you think it means." 92 * 93 * <p> This comment used to trigger a warning, but no longer does. 94 */ 95 public String author = "William Goldman"; 96 97 @Override 98 public String getName() { 99 return "Test"; 100 } 101 102 @Override 103 public Set<Option> getSupportedOptions() { 104 return Collections.emptySet(); 105 } 106 107 @Override 108 public SourceVersion getSupportedSourceVersion() { 109 return SourceVersion.latest(); 110 } 111 112 public void init(Locale locale, Reporter reporter) { 113 return; 114 } 115} 116