0N/A/*
553N/A * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.internal.toolkit.taglets;
0N/A
0N/Aimport com.sun.tools.doclets.internal.toolkit.util.*;
0N/Aimport com.sun.javadoc.*;
0N/A
0N/A/**
0N/A * An abstract class for that implements the {@link Taglet} interface.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
0N/A * @since 1.4
0N/A */
0N/Apublic abstract class BaseTaglet implements Taglet {
0N/A
0N/A protected String name = "Default";
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in constructor documentation.
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in constructor documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inConstructor() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in field documentation.
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in field documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inField() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in method documentation.
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in method documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inMethod() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in overview documentation.
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in method documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inOverview() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in package documentation.
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in package documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inPackage() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is used in type documentation (classes or interfaces).
0N/A * @return true if this <code>Taglet</code>
0N/A * is used in type documentation and false
0N/A * otherwise.
0N/A */
0N/A public boolean inType() {
0N/A return true;
0N/A }
0N/A
0N/A /**
0N/A * Return true if this <code>Taglet</code>
0N/A * is an inline tag.
0N/A * @return true if this <code>Taglet</code>
0N/A * is an inline tag and false otherwise.
0N/A */
0N/A public boolean isInlineTag() {
0N/A return false;
0N/A }
0N/A
0N/A /**
0N/A * Return the name of this custom tag.
0N/A * @return the name of this custom tag.
0N/A */
0N/A public String getName() {
0N/A return name;
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
0N/A */
0N/A public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {
0N/A throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
0N/A */
0N/A public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
0N/A throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
0N/A }
0N/A}