1 /*
2 * Copyright (c) 2003, 2013, 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
26 package com.sun.tools.doclets.internal.toolkit.taglets;
27
28 import com.sun.javadoc.*;
29 import com.sun.tools.doclets.internal.toolkit.Content;
30
31 /**
32 * An abstract class for that implements the {@link Taglet} interface.
33 *
34 * <p><b>This is NOT part of any supported API.
35 * If you write code that depends on this, you do so at your own risk.
36 * This code and its internal interfaces are subject to change or
37 * deletion without notice.</b>
38 *
39 * @author Jamie Ho
40 * @since 1.4
41 */
42 public abstract class BaseTaglet implements Taglet {
43
44 protected String name = "Default";
45
46 /**
47 * Return true if this <code>Taglet</code>
48 * is used in constructor documentation.
49 * @return true if this <code>Taglet</code>
50 * is used in constructor documentation and false
112 /**
113 * Return true if this <code>Taglet</code>
114 * is an inline tag.
115 * @return true if this <code>Taglet</code>
116 * is an inline tag and false otherwise.
117 */
118 public boolean isInlineTag() {
119 return false;
120 }
121
122 /**
123 * Return the name of this custom tag.
124 * @return the name of this custom tag.
125 */
126 public String getName() {
127 return name;
128 }
129
130 /**
131 * {@inheritDoc}
132 * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
133 */
134 public Content getTagletOutput(Tag tag, TagletWriter writer) {
135 throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
136 }
137
138 /**
139 * {@inheritDoc}
140 * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
141 */
142 public Content getTagletOutput(Doc holder, TagletWriter writer) {
143 throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
144 }
145 }
|
1 /*
2 * Copyright (c) 2003, 2015, 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
26 package jdk.javadoc.internal.doclets.toolkit.taglets;
27
28 import javax.lang.model.element.Element;
29
30 import com.sun.source.doctree.DocTree;
31 import 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 * @since 1.4
43 */
44 public abstract class BaseTaglet implements Taglet {
45
46 protected String name = "Default";
47
48 /**
49 * Return true if this <code>Taglet</code>
50 * is used in constructor documentation.
51 * @return true if this <code>Taglet</code>
52 * is used in constructor documentation and false
114 /**
115 * Return true if this <code>Taglet</code>
116 * is an inline tag.
117 * @return true if this <code>Taglet</code>
118 * is an inline tag and false otherwise.
119 */
120 public boolean isInlineTag() {
121 return false;
122 }
123
124 /**
125 * Return the name of this custom tag.
126 * @return the name of this custom tag.
127 */
128 public String getName() {
129 return name;
130 }
131
132 /**
133 * {@inheritDoc}
134 * @throws UnsupportedTagletOperationException thrown when the method is
135 * not supported by the taglet.
136 */
137 public Content getTagletOutput(Element element, DocTree tag, TagletWriter writer) {
138 throw new UnsupportedTagletOperationException("Method not supported in taglet " + getName() + ".");
139 }
140
141 /**
142 * {@inheritDoc}
143 * @throws UnsupportedTagletOperationException thrown when the method is not
144 * supported by the taglet.
145 */
146 public Content getTagletOutput(Element holder, TagletWriter writer) {
147 throw new UnsupportedTagletOperationException("Method not supported in taglet " + getName() + ".");
148 }
149 }
|