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