Sat, 01 Dec 2007 00:00:00 +0000
Initial load
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 29 | import com.sun.javadoc.*; |
duke@1 | 30 | |
duke@1 | 31 | /** |
duke@1 | 32 | * An abstract class for that implements the {@link Taglet} interface. |
duke@1 | 33 | * |
duke@1 | 34 | * This code is not part of an API. |
duke@1 | 35 | * It is implementation that is subject to change. |
duke@1 | 36 | * Do not use it as an API |
duke@1 | 37 | * |
duke@1 | 38 | * @author Jamie Ho |
duke@1 | 39 | * @since 1.4 |
duke@1 | 40 | */ |
duke@1 | 41 | public abstract class BaseTaglet implements Taglet { |
duke@1 | 42 | |
duke@1 | 43 | protected String name = "Default"; |
duke@1 | 44 | |
duke@1 | 45 | /** |
duke@1 | 46 | * Return true if this <code>Taglet</code> |
duke@1 | 47 | * is used in constructor documentation. |
duke@1 | 48 | * @return true if this <code>Taglet</code> |
duke@1 | 49 | * is used in constructor documentation and false |
duke@1 | 50 | * otherwise. |
duke@1 | 51 | */ |
duke@1 | 52 | public boolean inConstructor() { |
duke@1 | 53 | return true; |
duke@1 | 54 | } |
duke@1 | 55 | |
duke@1 | 56 | /** |
duke@1 | 57 | * Return true if this <code>Taglet</code> |
duke@1 | 58 | * is used in field documentation. |
duke@1 | 59 | * @return true if this <code>Taglet</code> |
duke@1 | 60 | * is used in field documentation and false |
duke@1 | 61 | * otherwise. |
duke@1 | 62 | */ |
duke@1 | 63 | public boolean inField() { |
duke@1 | 64 | return true; |
duke@1 | 65 | } |
duke@1 | 66 | |
duke@1 | 67 | /** |
duke@1 | 68 | * Return true if this <code>Taglet</code> |
duke@1 | 69 | * is used in method documentation. |
duke@1 | 70 | * @return true if this <code>Taglet</code> |
duke@1 | 71 | * is used in method documentation and false |
duke@1 | 72 | * otherwise. |
duke@1 | 73 | */ |
duke@1 | 74 | public boolean inMethod() { |
duke@1 | 75 | return true; |
duke@1 | 76 | } |
duke@1 | 77 | |
duke@1 | 78 | /** |
duke@1 | 79 | * Return true if this <code>Taglet</code> |
duke@1 | 80 | * is used in overview documentation. |
duke@1 | 81 | * @return true if this <code>Taglet</code> |
duke@1 | 82 | * is used in method documentation and false |
duke@1 | 83 | * otherwise. |
duke@1 | 84 | */ |
duke@1 | 85 | public boolean inOverview() { |
duke@1 | 86 | return true; |
duke@1 | 87 | } |
duke@1 | 88 | |
duke@1 | 89 | /** |
duke@1 | 90 | * Return true if this <code>Taglet</code> |
duke@1 | 91 | * is used in package documentation. |
duke@1 | 92 | * @return true if this <code>Taglet</code> |
duke@1 | 93 | * is used in package documentation and false |
duke@1 | 94 | * otherwise. |
duke@1 | 95 | */ |
duke@1 | 96 | public boolean inPackage() { |
duke@1 | 97 | return true; |
duke@1 | 98 | } |
duke@1 | 99 | |
duke@1 | 100 | /** |
duke@1 | 101 | * Return true if this <code>Taglet</code> |
duke@1 | 102 | * is used in type documentation (classes or interfaces). |
duke@1 | 103 | * @return true if this <code>Taglet</code> |
duke@1 | 104 | * is used in type documentation and false |
duke@1 | 105 | * otherwise. |
duke@1 | 106 | */ |
duke@1 | 107 | public boolean inType() { |
duke@1 | 108 | return true; |
duke@1 | 109 | } |
duke@1 | 110 | |
duke@1 | 111 | /** |
duke@1 | 112 | * Return true if this <code>Taglet</code> |
duke@1 | 113 | * is an inline tag. |
duke@1 | 114 | * @return true if this <code>Taglet</code> |
duke@1 | 115 | * is an inline tag and false otherwise. |
duke@1 | 116 | */ |
duke@1 | 117 | public boolean isInlineTag() { |
duke@1 | 118 | return false; |
duke@1 | 119 | } |
duke@1 | 120 | |
duke@1 | 121 | /** |
duke@1 | 122 | * Return the name of this custom tag. |
duke@1 | 123 | * @return the name of this custom tag. |
duke@1 | 124 | */ |
duke@1 | 125 | public String getName() { |
duke@1 | 126 | return name; |
duke@1 | 127 | } |
duke@1 | 128 | |
duke@1 | 129 | /** |
duke@1 | 130 | * {@inheritDoc} |
duke@1 | 131 | * @throws IllegalArgumentException thrown when the method is not supported by the taglet. |
duke@1 | 132 | */ |
duke@1 | 133 | public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) { |
duke@1 | 134 | throw new IllegalArgumentException("Method not supported in taglet " + getName() + "."); |
duke@1 | 135 | } |
duke@1 | 136 | |
duke@1 | 137 | /** |
duke@1 | 138 | * {@inheritDoc} |
duke@1 | 139 | * @throws IllegalArgumentException thrown when the method is not supported by the taglet. |
duke@1 | 140 | */ |
duke@1 | 141 | public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) { |
duke@1 | 142 | throw new IllegalArgumentException("Method not supported in taglet " + getName() + "."); |
duke@1 | 143 | } |
duke@1 | 144 | } |