Tue, 25 May 2010 15:54:51 -0700
6943119: Rebrand source copyright notices
Reviewed-by: darcy
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 2001, 2003, Oracle and/or its affiliates. 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 |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle 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 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * 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.javadoc.*; |
duke@1 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * A simple single argument custom tag. |
duke@1 | 32 | * |
duke@1 | 33 | * This code is not part of an API. |
duke@1 | 34 | * It is implementation that is subject to change. |
duke@1 | 35 | * Do not use it as an API |
duke@1 | 36 | * |
duke@1 | 37 | * @author Jamie Ho |
duke@1 | 38 | */ |
duke@1 | 39 | |
duke@1 | 40 | public class SimpleTaglet extends BaseTaglet { |
duke@1 | 41 | |
duke@1 | 42 | /** |
duke@1 | 43 | * The marker in the location string for excluded tags. |
duke@1 | 44 | */ |
duke@1 | 45 | public static final String EXCLUDED = "x"; |
duke@1 | 46 | |
duke@1 | 47 | /** |
duke@1 | 48 | * The marker in the location string for packages. |
duke@1 | 49 | */ |
duke@1 | 50 | public static final String PACKAGE = "p"; |
duke@1 | 51 | |
duke@1 | 52 | /** |
duke@1 | 53 | * The marker in the location string for types. |
duke@1 | 54 | */ |
duke@1 | 55 | public static final String TYPE = "t"; |
duke@1 | 56 | |
duke@1 | 57 | /** |
duke@1 | 58 | * The marker in the location string for constructors. |
duke@1 | 59 | */ |
duke@1 | 60 | public static final String CONSTRUCTOR = "c"; |
duke@1 | 61 | |
duke@1 | 62 | /** |
duke@1 | 63 | * The marker in the location string for fields. |
duke@1 | 64 | */ |
duke@1 | 65 | public static final String FIELD = "f"; |
duke@1 | 66 | |
duke@1 | 67 | /** |
duke@1 | 68 | * The marker in the location string for methods. |
duke@1 | 69 | */ |
duke@1 | 70 | public static final String METHOD = "m"; |
duke@1 | 71 | |
duke@1 | 72 | /** |
duke@1 | 73 | * The marker in the location string for overview. |
duke@1 | 74 | */ |
duke@1 | 75 | public static final String OVERVIEW = "o"; |
duke@1 | 76 | |
duke@1 | 77 | /** |
duke@1 | 78 | * Use in location string when the tag is to |
duke@1 | 79 | * appear in all locations. |
duke@1 | 80 | */ |
duke@1 | 81 | public static final String ALL = "a"; |
duke@1 | 82 | |
duke@1 | 83 | /** |
duke@1 | 84 | * The name of this tag. |
duke@1 | 85 | */ |
duke@1 | 86 | protected String tagName; |
duke@1 | 87 | |
duke@1 | 88 | /** |
duke@1 | 89 | * The header to output. |
duke@1 | 90 | */ |
duke@1 | 91 | protected String header; |
duke@1 | 92 | |
duke@1 | 93 | /** |
duke@1 | 94 | * The possible locations that this tag can appear in. |
duke@1 | 95 | */ |
duke@1 | 96 | protected String locations; |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * Construct a <code>SimpleTaglet</code>. |
duke@1 | 100 | * @param tagName the name of this tag |
duke@1 | 101 | * @param header the header to output. |
duke@1 | 102 | * @param locations the possible locations that this tag |
duke@1 | 103 | * can appear in. The <code>String</code> can contain 'p' |
duke@1 | 104 | * for package, 't' for type, 'm' for method, 'c' for constructor |
duke@1 | 105 | * and 'f' for field. |
duke@1 | 106 | */ |
duke@1 | 107 | public SimpleTaglet(String tagName, String header, String locations) { |
duke@1 | 108 | this.tagName = tagName; |
duke@1 | 109 | this.header = header; |
duke@1 | 110 | locations = locations.toLowerCase(); |
duke@1 | 111 | if (locations.indexOf(ALL) != -1 && locations.indexOf(EXCLUDED) == -1) { |
duke@1 | 112 | this.locations = PACKAGE + TYPE + FIELD + METHOD + CONSTRUCTOR + OVERVIEW; |
duke@1 | 113 | } else { |
duke@1 | 114 | this.locations = locations; |
duke@1 | 115 | } |
duke@1 | 116 | } |
duke@1 | 117 | |
duke@1 | 118 | /** |
duke@1 | 119 | * Return the name of this <code>Taglet</code>. |
duke@1 | 120 | */ |
duke@1 | 121 | public String getName() { |
duke@1 | 122 | return tagName; |
duke@1 | 123 | } |
duke@1 | 124 | |
duke@1 | 125 | /** |
duke@1 | 126 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 127 | * is used in constructor documentation. |
duke@1 | 128 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 129 | * is used in constructor documentation and false |
duke@1 | 130 | * otherwise. |
duke@1 | 131 | */ |
duke@1 | 132 | public boolean inConstructor() { |
duke@1 | 133 | return locations.indexOf(CONSTRUCTOR) != -1 && locations.indexOf(EXCLUDED) == -1; |
duke@1 | 134 | } |
duke@1 | 135 | |
duke@1 | 136 | /** |
duke@1 | 137 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 138 | * is used in field documentation. |
duke@1 | 139 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 140 | * is used in field documentation and false |
duke@1 | 141 | * otherwise. |
duke@1 | 142 | */ |
duke@1 | 143 | public boolean inField() { |
duke@1 | 144 | return locations.indexOf(FIELD) != -1 && locations.indexOf(EXCLUDED) == -1; |
duke@1 | 145 | } |
duke@1 | 146 | |
duke@1 | 147 | /** |
duke@1 | 148 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 149 | * is used in method documentation. |
duke@1 | 150 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 151 | * is used in method documentation and false |
duke@1 | 152 | * otherwise. |
duke@1 | 153 | */ |
duke@1 | 154 | public boolean inMethod() { |
duke@1 | 155 | return locations.indexOf(METHOD) != -1 && locations.indexOf(EXCLUDED) == -1; |
duke@1 | 156 | } |
duke@1 | 157 | |
duke@1 | 158 | /** |
duke@1 | 159 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 160 | * is used in overview documentation. |
duke@1 | 161 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 162 | * is used in overview documentation and false |
duke@1 | 163 | * otherwise. |
duke@1 | 164 | */ |
duke@1 | 165 | public boolean inOverview() { |
duke@1 | 166 | return locations.indexOf(OVERVIEW) != -1 && locations.indexOf(EXCLUDED) == -1; |
duke@1 | 167 | } |
duke@1 | 168 | |
duke@1 | 169 | /** |
duke@1 | 170 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 171 | * is used in package documentation. |
duke@1 | 172 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 173 | * is used in package documentation and false |
duke@1 | 174 | * otherwise. |
duke@1 | 175 | */ |
duke@1 | 176 | public boolean inPackage() { |
duke@1 | 177 | return locations.indexOf(PACKAGE) != -1 && locations.indexOf(EXCLUDED) == -1; |
duke@1 | 178 | } |
duke@1 | 179 | |
duke@1 | 180 | /** |
duke@1 | 181 | * Return true if this <code>SimpleTaglet</code> |
duke@1 | 182 | * is used in type documentation (classes or interfaces). |
duke@1 | 183 | * @return true if this <code>SimpleTaglet</code> |
duke@1 | 184 | * is used in type documentation and false |
duke@1 | 185 | * otherwise. |
duke@1 | 186 | */ |
duke@1 | 187 | public boolean inType() { |
duke@1 | 188 | return locations.indexOf(TYPE) != -1&& locations.indexOf(EXCLUDED) == -1; |
duke@1 | 189 | } |
duke@1 | 190 | |
duke@1 | 191 | /** |
duke@1 | 192 | * Return true if this <code>Taglet</code> |
duke@1 | 193 | * is an inline tag. |
duke@1 | 194 | * @return true if this <code>Taglet</code> |
duke@1 | 195 | * is an inline tag and false otherwise. |
duke@1 | 196 | */ |
duke@1 | 197 | public boolean isInlineTag() { |
duke@1 | 198 | return false; |
duke@1 | 199 | } |
duke@1 | 200 | |
duke@1 | 201 | /** |
duke@1 | 202 | * {@inheritDoc} |
duke@1 | 203 | */ |
duke@1 | 204 | public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) { |
duke@1 | 205 | return header == null || tag == null ? null : writer.simpleTagOutput(tag, header); |
duke@1 | 206 | } |
duke@1 | 207 | |
duke@1 | 208 | /** |
duke@1 | 209 | * {@inheritDoc} |
duke@1 | 210 | */ |
duke@1 | 211 | public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) { |
duke@1 | 212 | if (header == null || holder.tags(getName()).length == 0) { |
duke@1 | 213 | return null; |
duke@1 | 214 | } |
duke@1 | 215 | return writer.simpleTagOutput(holder.tags(getName()), header); |
duke@1 | 216 | } |
duke@1 | 217 | } |