duke@1: /*
duke@1:  * Copyright 2003 Sun Microsystems, Inc.  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
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun 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:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * An abstract class for that implements the {@link Taglet} interface.
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:  * @since 1.4
duke@1:  */
duke@1: public abstract class BaseTaglet implements Taglet {
duke@1: 
duke@1:     protected String name = "Default";
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in constructor documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in constructor documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inConstructor() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in field documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in field documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inField() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in method documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in method documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inMethod() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in overview documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in method documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inOverview() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in package documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in package documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inPackage() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in type documentation (classes or interfaces).
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in type documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inType() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is an inline tag.
duke@1:      * @return true if this <code>Taglet</code>
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:      * Return the name of this custom tag.
duke@1:      * @return the name of this custom tag.
duke@1:      */
duke@1:     public String getName() {
duke@1:         return name;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
duke@1:      */
duke@1:     public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {
duke@1:         throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
duke@1:      */
duke@1:     public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
duke@1:         throw new IllegalArgumentException("Method not supported in taglet " + getName() + ".");
duke@1:     }
duke@1: }