diff -r 000000000000 -r 959103a6100f src/share/classes/com/sun/tools/doclets/Taglet.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/tools/doclets/Taglet.java Wed Apr 27 01:34:52 2016 +0800 @@ -0,0 +1,157 @@ +/* + * Copyright (c) 2001, 2006, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package com.sun.tools.doclets; + +import com.sun.javadoc.*; + +/** + * The interface for a custom tag used by Doclets. A custom + * tag must implement this interface. To be loaded and used by + * doclets at run-time, the taglet must have a static method called + * register that accepts a {@link java.util.Map} as an + * argument with the following signature: + *
+ *   public void register(Map map)
+ * 
+ * This method should add an instance of the custom taglet to the map + * with the name of the taglet as the key. If overriding a taglet, + * to avoid a name conflict, the overridden taglet must be deleted from + * the map before an instance of the new taglet is added to the map. + *

+ * It is recommended that the taglet throw an exception when it fails + * to register itself. The exception that it throws is up to the user. + *

+ * Here are two sample taglets:
+ *

+ *

+ * For more information on how to create your own Taglets, please see the + * Taglet Overview. + * + * @since 1.4 + * @author Jamie Ho + */ + +public interface Taglet { + + /** + * Return true if this Taglet + * is used in field documentation. Set to + * false for inline tags. + * @return true if this Taglet + * is used in field documentation and false + * otherwise. + */ + public abstract boolean inField(); + + /** + * Return true if this Taglet + * is used in constructor documentation. Set to + * false for inline tags. + * @return true if this Taglet + * is used in constructor documentation and false + * otherwise. + */ + public abstract boolean inConstructor(); + + /** + * Return true if this Taglet + * is used in method documentation. Set to + * false for inline tags. + * @return true if this Taglet + * is used in method documentation and false + * otherwise. + */ + public abstract boolean inMethod(); + + /** + * Return true if this Taglet + * is used in overview documentation. Set to + * false for inline tags. + * @return true if this Taglet + * is used in method documentation and false + * otherwise. + */ + public abstract boolean inOverview(); + + /** + * Return true if this Taglet + * is used in package documentation. Set to + * false for inline tags. + * @return true if this Taglet + * is used in package documentation and false + * otherwise. + */ + public abstract boolean inPackage(); + + /** + * Return true if this Taglet + * is used in type documentation (classes or + * interfaces). Set to false for inline tags. + * @return true if this Taglet + * is used in type documentation and false + * otherwise. + */ + public abstract boolean inType(); + + /** + * Return true if this Taglet + * is an inline tag. Return false otherwise. + * @return true if this Taglet + * is an inline tag and false otherwise. + */ + public abstract boolean isInlineTag(); + + /** + * Return the name of this custom tag. + * @return the name of this custom tag. + */ + public abstract String getName(); + + /** + * Given the Tag representation of this custom + * tag, return its string representation, which is output + * to the generated page. + * @param tag the Tag representation of this custom tag. + * @return the string representation of this Tag. + */ + public abstract String toString(Tag tag); + + /** + * Given an array of Tags representing this custom + * tag, return its string representation, which is output + * to the generated page. This method should + * return null if this taglet represents an inline tag. + * @param tags the array of Tags representing of this custom tag. + * @return the string representation of this Tag. + */ + public abstract String toString(Tag[] tags); + +}