1/*
2 * Copyright (c) 2017, 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package build.tools.taglet;
27
28import java.util.EnumSet;
29import java.util.List;
30import java.util.Set;
31import javax.lang.model.element.Element;
32import com.sun.source.doctree.DocTree;
33import jdk.javadoc.doclet.Taglet;
34import static jdk.javadoc.doclet.Taglet.Location.*;
35
36/**
37 * An inline tag to conveniently insert a standard Incubating warning.  For
38 * use by members in Incubator Modules.
39 */
40public class Incubating implements Taglet {
41
42    /** Returns the set of locations in which a taglet may be used. */
43    @Override
44    public Set<Location> getAllowedLocations() {
45        return EnumSet.of(OVERVIEW, MODULE, PACKAGE, TYPE);
46    }
47
48    @Override
49    public boolean isInlineTag() {
50        return true;
51    }
52
53    @Override
54    public String getName() {
55        return "Incubating";
56    }
57
58    private static final String MESSAGE =
59        "<BR><b><a href=\"http://openjdk.java.net/jeps/11\">Incubating Feature.</a>"
60                + " Will be removed in a future release.</b>";
61
62    @Override
63    public String toString(List<? extends DocTree> tags, Element elem) {
64        return MESSAGE;
65    }
66}
67
68