src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/Taglet.java

@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2016, 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

@@ -21,42 +21,19 @@
  * 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.internal.toolkit.taglets;
+package jdk.javadoc.internal.doclets.toolkit.taglets;
 
-import com.sun.javadoc.*;
-import com.sun.tools.doclets.internal.toolkit.Content;
+import javax.lang.model.element.Element;
 
+import com.sun.source.doctree.DocTree;
+import jdk.javadoc.internal.doclets.toolkit.Content;
+
 /**
- * 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
- * <code>register</code> that accepts a {@link java.util.Map} as an
- * argument with the following signature:
- * <pre>
- *   public void register(Map map)
- * </pre>
- * 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.
- * <p>
- * 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.
- * <p>
- * Here are two sample taglets: <br>
- * <ul>
- *     <li><a href="{@docRoot}/ToDoTaglet.java">ToDoTaglet.java</a>
- *         - Standalone taglet</li>
- *     <li><a href="{@docRoot}/UnderlineTaglet.java">UnderlineTaglet.java</a>
- *         - Inline taglet</li>
- * </ul>
- * <p>
- * For more information on how to create your own Taglets, please see the
- * <a href="{@docRoot}/overview.html">Taglet Overview</a>.
+ * This is the Taglet interface used internally within the doclet.
  *
  * @since 1.4
  * @author Jamie Ho
  */
 

@@ -133,26 +110,37 @@
 
     /**
      * Given the <code>Tag</code> representation of this custom
      * tag, return its Content representation, which is output
      * to the generated page.
+     * @param holder the element holding the tag
      * @param tag the <code>Tag</code> representation of this custom tag.
      * @param writer a {@link TagletWriter} Taglet writer.
-     * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
+     * @throws UnsupportedOperationException thrown when the method is not supported by the taglet.
      * @return the Content representation of this <code>Tag</code>.
      */
-    public abstract Content getTagletOutput(Tag tag, TagletWriter writer) throws IllegalArgumentException;
+    public abstract Content getTagletOutput(Element holder, DocTree tag, TagletWriter writer) throws
+            UnsupportedOperationException;
 
     /**
      * Given a <code>Doc</code> object, check if it holds any tags of
      * this type.  If it does, return the string representing the output.
      * If it does not, return null.
      * @param holder a {@link Doc} object holding the custom tag.
      * @param writer a {@link TagletWriter} Taglet writer.
-     * @throws IllegalArgumentException thrown when the method is not supported by the taglet.
+     * @throws UnsupportedTagletOperationException thrown when the method is not
+     *         supported by the taglet.
      * @return the TagletOutput representation of this <code>Tag</code>.
      */
-    public abstract Content getTagletOutput(Doc holder, TagletWriter writer) throws IllegalArgumentException;
+    public abstract Content getTagletOutput(Element holder, TagletWriter writer) throws
+            UnsupportedTagletOperationException;
 
     @Override
     public abstract String toString();
+
+    static class UnsupportedTagletOperationException extends UnsupportedOperationException {
+        private static final long serialVersionUID = -3530273193380250271L;
+        public UnsupportedTagletOperationException(String message) {
+            super(message);
+        }
+    };
 }