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