make/jdk/src/classes/build/tools/taglet/Preview.java
author jjg
Wed, 25 Sep 2019 21:19:21 +0200
branchJDK-8226585-branch
changeset 58342 ebb1ff3d6707
child 58440 4c8a6d1d066c
permissions -rw-r--r--
Adding taglet for @preview.
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
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    28
import java.util.EnumSet;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    29
import java.util.List;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    30
import java.util.Set;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    31
import javax.lang.model.element.Element;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    32
import com.sun.source.doctree.DocTree;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    33
import com.sun.source.doctree.UnknownBlockTagTree;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    34
import jdk.javadoc.doclet.Taglet;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    35
import static jdk.javadoc.doclet.Taglet.Location.*;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    36
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    37
/**
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    38
 * An block tag to insert a standard warning about a preview API.
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    39
 */
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    40
public class Preview implements Taglet {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    41
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    42
    /** Returns the set of locations in which a taglet may be used. */
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    43
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    44
    public Set<Location> getAllowedLocations() {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    45
        return EnumSet.of(MODULE, PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD);
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    46
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    47
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    48
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    49
    public boolean isInlineTag() {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    50
        return false;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    51
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    52
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    53
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    54
    public String getName() {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    55
        return "preview";
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    56
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    57
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    58
    @Override
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    59
    public String toString(List<? extends DocTree> tags, Element elem) {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    60
        StringBuilder sb = new StringBuilder();
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    61
	sb.append("<dt>Preview Feature:\n");
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    62
        for (DocTree tag : tags) {
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    63
	    UnknownBlockTagTree ubt = (UnknownBlockTagTree) tag;
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    64
	    sb.append("<dd style=\"border: 1px solid red; border-radius: 5px; padding: 5px; font-size: larger\"> <b>Preview:</b> ")
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    65
		.append(ubt.getContent()); 
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    66
        }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    67
	return sb.toString();
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    68
    }
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    69
}
ebb1ff3d6707 Adding taglet for @preview.
jjg
parents:
diff changeset
    70