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:  * The interface for a custom tag used by Doclets. A custom
aoqi@0:  * tag must implement this interface.  To be loaded and used by
aoqi@0:  * doclets at run-time, the taglet must have a static method called
aoqi@0:  * <code>register</code> that accepts a {@link java.util.Map} as an
aoqi@0:  * argument with the following signature:
aoqi@0:  * <pre>
aoqi@0:  *   public void register(Map map)
aoqi@0:  * </pre>
aoqi@0:  * This method should add an instance of the custom taglet to the map
aoqi@0:  * with the name of the taglet as the key.  If overriding a taglet,
aoqi@0:  * to avoid a name conflict, the overridden taglet must be deleted from
aoqi@0:  * the map before an instance of the new taglet is added to the map.
aoqi@0:  * <p>
aoqi@0:  * It is recommended that the taglet throw an exception when it fails
aoqi@0:  * to register itself.  The exception that it throws is up to the user.
aoqi@0:  * <p>
aoqi@0:  * Here are two sample taglets: <br>
aoqi@0:  * <ul>
aoqi@0:  *     <li><a href="{@docRoot}/ToDoTaglet.java">ToDoTaglet.java</a>
aoqi@0:  *         - Standalone taglet</li>
aoqi@0:  *     <li><a href="{@docRoot}/UnderlineTaglet.java">UnderlineTaglet.java</a>
aoqi@0:  *         - Inline taglet</li>
aoqi@0:  * </ul>
aoqi@0:  * <p>
aoqi@0:  * For more information on how to create your own Taglets, please see the
aoqi@0:  * <a href="{@docRoot}/overview.html">Taglet Overview</a>.
aoqi@0:  *
aoqi@0:  * @since 1.4
aoqi@0:  * @author Jamie Ho
aoqi@0:  */
aoqi@0: 
aoqi@0: public interface Taglet {
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 abstract boolean inField();
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 abstract boolean inConstructor();
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 abstract boolean inMethod();
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 abstract boolean inOverview();
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 abstract boolean inPackage();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if this <code>Taglet</code>
aoqi@0:      * is used in type documentation (classes or
aoqi@0:      * 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 abstract boolean inType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if this <code>Taglet</code>
aoqi@0:      * is an inline tag. Return false otherwise.
aoqi@0:      * @return true if this <code>Taglet</code>
aoqi@0:      * is an inline tag and false otherwise.
aoqi@0:      */
aoqi@0:     public abstract boolean isInlineTag();
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 abstract String getName();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Given the <code>Tag</code> representation of this custom
aoqi@0:      * tag, return its Content representation, which is output
aoqi@0:      * to the generated page.
aoqi@0:      * @param tag the <code>Tag</code> representation of this custom tag.
aoqi@0:      * @param writer a {@link TagletWriter} Taglet writer.
aoqi@0:      * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
aoqi@0:      * @return the Content representation of this <code>Tag</code>.
aoqi@0:      */
aoqi@0:     public abstract Content getTagletOutput(Tag tag, TagletWriter writer) throws IllegalArgumentException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Given a <code>Doc</code> object, check if it holds any tags of
aoqi@0:      * this type.  If it does, return the string representing the output.
aoqi@0:      * If it does not, return null.
aoqi@0:      * @param holder a {@link Doc} object holding the custom tag.
aoqi@0:      * @param writer a {@link TagletWriter} Taglet writer.
aoqi@0:      * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
aoqi@0:      * @return the TagletOutput representation of this <code>Tag</code>.
aoqi@0:      */
aoqi@0:     public abstract Content getTagletOutput(Doc holder, TagletWriter writer) throws IllegalArgumentException;
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public abstract String toString();
aoqi@0: }