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