duke@1: /*
ohair@554: * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1:
duke@1: /**
duke@1: * A simple single argument custom tag.
duke@1: *
duke@1: * This code is not part of an API.
duke@1: * It is implementation that is subject to change.
duke@1: * Do not use it as an API
duke@1: *
duke@1: * @author Jamie Ho
duke@1: */
duke@1:
duke@1: public class SimpleTaglet extends BaseTaglet {
duke@1:
duke@1: /**
duke@1: * The marker in the location string for excluded tags.
duke@1: */
duke@1: public static final String EXCLUDED = "x";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for packages.
duke@1: */
duke@1: public static final String PACKAGE = "p";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for types.
duke@1: */
duke@1: public static final String TYPE = "t";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for constructors.
duke@1: */
duke@1: public static final String CONSTRUCTOR = "c";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for fields.
duke@1: */
duke@1: public static final String FIELD = "f";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for methods.
duke@1: */
duke@1: public static final String METHOD = "m";
duke@1:
duke@1: /**
duke@1: * The marker in the location string for overview.
duke@1: */
duke@1: public static final String OVERVIEW = "o";
duke@1:
duke@1: /**
duke@1: * Use in location string when the tag is to
duke@1: * appear in all locations.
duke@1: */
duke@1: public static final String ALL = "a";
duke@1:
duke@1: /**
duke@1: * The name of this tag.
duke@1: */
duke@1: protected String tagName;
duke@1:
duke@1: /**
duke@1: * The header to output.
duke@1: */
duke@1: protected String header;
duke@1:
duke@1: /**
duke@1: * The possible locations that this tag can appear in.
duke@1: */
duke@1: protected String locations;
duke@1:
duke@1: /**
duke@1: * Construct a SimpleTaglet
.
duke@1: * @param tagName the name of this tag
duke@1: * @param header the header to output.
duke@1: * @param locations the possible locations that this tag
duke@1: * can appear in. The String
can contain 'p'
duke@1: * for package, 't' for type, 'm' for method, 'c' for constructor
duke@1: * and 'f' for field.
duke@1: */
duke@1: public SimpleTaglet(String tagName, String header, String locations) {
duke@1: this.tagName = tagName;
duke@1: this.header = header;
duke@1: locations = locations.toLowerCase();
duke@1: if (locations.indexOf(ALL) != -1 && locations.indexOf(EXCLUDED) == -1) {
duke@1: this.locations = PACKAGE + TYPE + FIELD + METHOD + CONSTRUCTOR + OVERVIEW;
duke@1: } else {
duke@1: this.locations = locations;
duke@1: }
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return the name of this Taglet
.
duke@1: */
duke@1: public String getName() {
duke@1: return tagName;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in constructor documentation.
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in constructor documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inConstructor() {
duke@1: return locations.indexOf(CONSTRUCTOR) != -1 && locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in field documentation.
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in field documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inField() {
duke@1: return locations.indexOf(FIELD) != -1 && locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in method documentation.
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in method documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inMethod() {
duke@1: return locations.indexOf(METHOD) != -1 && locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in overview documentation.
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in overview documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inOverview() {
duke@1: return locations.indexOf(OVERVIEW) != -1 && locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in package documentation.
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in package documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inPackage() {
duke@1: return locations.indexOf(PACKAGE) != -1 && locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this SimpleTaglet
duke@1: * is used in type documentation (classes or interfaces).
duke@1: * @return true if this SimpleTaglet
duke@1: * is used in type documentation and false
duke@1: * otherwise.
duke@1: */
duke@1: public boolean inType() {
duke@1: return locations.indexOf(TYPE) != -1&& locations.indexOf(EXCLUDED) == -1;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Return true if this Taglet
duke@1: * is an inline tag.
duke@1: * @return true if this Taglet
duke@1: * is an inline tag and false otherwise.
duke@1: */
duke@1: public boolean isInlineTag() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {
duke@1: return header == null || tag == null ? null : writer.simpleTagOutput(tag, header);
duke@1: }
duke@1:
duke@1: /**
duke@1: * {@inheritDoc}
duke@1: */
duke@1: public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
duke@1: if (header == null || holder.tags(getName()).length == 0) {
duke@1: return null;
duke@1: }
duke@1: return writer.simpleTagOutput(holder.tags(getName()), header);
duke@1: }
duke@1: }