< prev index next >

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

Print this page




   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.toolkit.taglets;
  27 

  28 import java.util.List;
  29 
  30 import javax.lang.model.element.Element;
  31 import javax.lang.model.element.VariableElement;
  32 import javax.lang.model.type.TypeMirror;
  33 
  34 import com.sun.source.doctree.DocTree;
  35 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
  36 import jdk.javadoc.internal.doclets.toolkit.Content;
  37 import jdk.javadoc.internal.doclets.toolkit.taglets.Taglet.UnsupportedTagletOperationException;
  38 import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
  39 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
  40 
  41 /**
  42  * The interface for the taglet writer.
  43  *
  44  *  <p><b>This is NOT part of any supported API.
  45  *  If you write code that depends on this, you do so at your own risk.
  46  *  This code and its internal interfaces are subject to change or
  47  *  deletion without notice.</b>


 133      */
 134     protected abstract Content propertyTagOutput(Element element, DocTree propertyTag, String prefix);
 135 
 136     /**
 137      * Return the return tag output.
 138      *
 139      * @param element
 140      * @param returnTag the return tag to output.
 141      * @return the output of the return tag.
 142      */
 143     protected abstract Content returnTagOutput(Element element, DocTree returnTag);
 144 
 145     /**
 146      * Return the see tag output.
 147      *
 148      * @param holder
 149      * @param seeTags the array of See tags.
 150      * @return the output of the see tags.
 151      */
 152     protected abstract Content seeTagOutput(Element holder, List<? extends DocTree> seeTags);









 153 
 154     /**
 155      * Return the output for a simple tag.
 156      *
 157      * @param element
 158      * @param simpleTags the array of simple tags.
 159      * @param header
 160      * @return the output of the simple tags.
 161      */
 162     protected abstract Content simpleTagOutput(Element element, List<? extends DocTree> simpleTags, String header);
 163 
 164     /**
 165      * Return the output for a simple tag.
 166      *
 167      * @param element
 168      * @param simpleTag the simple tag.
 169      * @param header
 170      * @return the output of the simple tag.
 171      */
 172     protected abstract Content simpleTagOutput(Element element, DocTree simpleTag, String header);




   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.toolkit.taglets;
  27 
  28 import java.util.EnumSet;
  29 import java.util.List;
  30 
  31 import javax.lang.model.element.Element;
  32 import javax.lang.model.element.VariableElement;
  33 import javax.lang.model.type.TypeMirror;
  34 
  35 import com.sun.source.doctree.DocTree;
  36 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
  37 import jdk.javadoc.internal.doclets.toolkit.Content;
  38 import jdk.javadoc.internal.doclets.toolkit.taglets.Taglet.UnsupportedTagletOperationException;
  39 import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
  40 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
  41 
  42 /**
  43  * The interface for the taglet writer.
  44  *
  45  *  <p><b>This is NOT part of any supported API.
  46  *  If you write code that depends on this, you do so at your own risk.
  47  *  This code and its internal interfaces are subject to change or
  48  *  deletion without notice.</b>


 134      */
 135     protected abstract Content propertyTagOutput(Element element, DocTree propertyTag, String prefix);
 136 
 137     /**
 138      * Return the return tag output.
 139      *
 140      * @param element
 141      * @param returnTag the return tag to output.
 142      * @return the output of the return tag.
 143      */
 144     protected abstract Content returnTagOutput(Element element, DocTree returnTag);
 145 
 146     /**
 147      * Return the see tag output.
 148      *
 149      * @param holder
 150      * @param seeTags the array of See tags.
 151      * @return the output of the see tags.
 152      */
 153     protected abstract Content seeTagOutput(Element holder, List<? extends DocTree> seeTags);
 154 
 155     /**
 156      * Return the accessor tag output.
 157      *
 158      * @param holder
 159      * @param tags the accessor tags
 160      * @return the output of the accessor tag.
 161      */
 162     protected abstract Content accessorTagOutput(Element holder, List<? extends DocTree> tags);
 163 
 164     /**
 165      * Return the output for a simple tag.
 166      *
 167      * @param element
 168      * @param simpleTags the array of simple tags.
 169      * @param header
 170      * @return the output of the simple tags.
 171      */
 172     protected abstract Content simpleTagOutput(Element element, List<? extends DocTree> simpleTags, String header);
 173 
 174     /**
 175      * Return the output for a simple tag.
 176      *
 177      * @param element
 178      * @param simpleTag the simple tag.
 179      * @param header
 180      * @return the output of the simple tag.
 181      */
 182     protected abstract Content simpleTagOutput(Element element, DocTree simpleTag, String header);


< prev index next >