BaseTaglet.java revision 3233:b5d08bc0d224 
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.  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 jdk.javadoc.internal.doclets.toolkit.taglets;
27
28import javax.lang.model.element.Element;
29
30import com.sun.source.doctree.DocTree;
31import jdk.javadoc.internal.doclets.toolkit.Content;
32
33/**
34 * An abstract class for that implements the {@link Taglet} interface.
35 *
36 *  <p><b>This is NOT part of any supported API.
37 *  If you write code that depends on this, you do so at your own risk.
38 *  This code and its internal interfaces are subject to change or
39 *  deletion without notice.</b>
40 *
41 * @author Jamie Ho
42 */
43public abstract class BaseTaglet implements Taglet {
44
45    protected String name = "Default";
46
47    /**
48     * Return true if this <code>Taglet</code>
49     * is used in constructor documentation.
50     * @return true if this <code>Taglet</code>
51     * is used in constructor documentation and false
52     * otherwise.
53     */
54    public boolean inConstructor() {
55        return true;
56    }
57
58    /**
59     * Return true if this <code>Taglet</code>
60     * is used in field documentation.
61     * @return true if this <code>Taglet</code>
62     * is used in field documentation and false
63     * otherwise.
64     */
65    public boolean inField() {
66        return true;
67    }
68
69    /**
70     * Return true if this <code>Taglet</code>
71     * is used in method documentation.
72     * @return true if this <code>Taglet</code>
73     * is used in method documentation and false
74     * otherwise.
75     */
76    public boolean inMethod() {
77        return true;
78    }
79
80    /**
81     * Return true if this <code>Taglet</code>
82     * is used in overview documentation.
83     * @return true if this <code>Taglet</code>
84     * is used in method documentation and false
85     * otherwise.
86     */
87    public boolean inOverview() {
88        return true;
89    }
90
91    /**
92     * Return true if this <code>Taglet</code>
93     * is used in package documentation.
94     * @return true if this <code>Taglet</code>
95     * is used in package documentation and false
96     * otherwise.
97     */
98    public boolean inPackage() {
99        return true;
100    }
101
102    /**
103     * Return true if this <code>Taglet</code>
104     * is used in type documentation (classes or interfaces).
105     * @return true if this <code>Taglet</code>
106     * is used in type documentation and false
107     * otherwise.
108     */
109    public boolean inType() {
110        return true;
111    }
112
113    /**
114     * Return true if this <code>Taglet</code>
115     * is an inline tag.
116     * @return true if this <code>Taglet</code>
117     * is an inline tag and false otherwise.
118     */
119    public boolean isInlineTag() {
120        return false;
121    }
122
123    /**
124     * Return the name of this custom tag.
125     * @return the name of this custom tag.
126     */
127    public String getName() {
128        return name;
129    }
130
131    /**
132     * {@inheritDoc}
133     * @throws UnsupportedTagletOperationException thrown when the method is
134     *         not supported by the taglet.
135     */
136    public Content getTagletOutput(Element element, DocTree tag, TagletWriter writer) {
137        throw new UnsupportedTagletOperationException("Method not supported in taglet " + getName() + ".");
138    }
139
140    /**
141     * {@inheritDoc}
142     * @throws UnsupportedTagletOperationException thrown when the method is not
143     *         supported by the taglet.
144     */
145    public Content getTagletOutput(Element holder, TagletWriter writer) {
146        throw new UnsupportedTagletOperationException("Method not supported in taglet " + getName() + ".");
147    }
148}
149