make/jdk/src/classes/build/tools/taglet/Preview.java
author jlahoda
Wed, 02 Oct 2019 11:29:49 +0200
branchJDK-8226585-branch
changeset 58441 82f43796b28c
parent 58440 4c8a6d1d066c
permissions -rw-r--r--
Cleanup
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     1
/*
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     4
 *
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    10
 *
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    15
 * accompanied this code).
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    16
 *
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    20
 *
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    23
 * questions.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    24
 */
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    25
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    26
package build.tools.taglet;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    27
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    28
import java.util.Arrays;
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    29
import java.util.EnumSet;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    30
import java.util.List;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    31
import java.util.Set;
58441
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    32
import java.util.function.Predicate;
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    33
import javax.lang.model.element.Element;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    34
import com.sun.source.doctree.DocTree;
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    35
import com.sun.source.doctree.TextTree;
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    36
import com.sun.source.doctree.UnknownInlineTagTree;
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    37
import jdk.javadoc.doclet.Taglet;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    38
import static jdk.javadoc.doclet.Taglet.Location.*;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    39
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    40
/**
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    41
 * An block tag to insert a standard warning about a preview API.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    42
 */
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    43
public class Preview implements Taglet {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    44
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    45
    /** Returns the set of locations in which a taglet may be used. */
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    46
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    47
    public Set<Location> getAllowedLocations() {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    48
        return EnumSet.of(MODULE, PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD);
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    49
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    50
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    51
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    52
    public boolean isInlineTag() {
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    53
        return true;
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    54
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    55
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    56
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    57
    public String getName() {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    58
        return "preview";
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    59
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    60
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    61
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    62
    public String toString(List<? extends DocTree> tags, Element elem) {
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    63
        UnknownInlineTagTree previewTag = (UnknownInlineTagTree) tags.get(0);
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    64
        List<? extends DocTree> previewContent = previewTag.getContent();
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    65
        String previewText = ((TextTree) previewContent.get(0)).getBody();
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    66
        String[] summaryAndDetails = previewText.split("\n\r?\n\r?");
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    67
        String summary = summaryAndDetails[0];
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    68
        String details = summaryAndDetails.length > 1 ? summaryAndDetails[1] : summaryAndDetails[0];
58441
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    69
        StackTraceElement[] stackTrace = new Exception().getStackTrace();
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    70
        Predicate<StackTraceElement> isSummary =
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    71
                el -> el.getClassName().endsWith("HtmlDocletWriter") &&
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    72
                      el.getMethodName().equals("addSummaryComment");
82f43796b28c Cleanup
jlahoda
parents: 58440
diff changeset
    73
        if (Arrays.stream(stackTrace).anyMatch(isSummary)) {
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    74
            return "<div style=\"display:inline-block; font-weight:bold\">" + summary + "</div><br>";
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    75
        }
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58342
diff changeset
    76
        return "<div style=\"border: 1px solid red; border-radius: 25px; padding: 5px; display:inline-block; font-size: larger\">" + details + "</div><br>";
58342
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    77
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    78
}
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    79