1 /*
   2  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   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 
  30 import com.sun.source.doctree.DocTree;
  31 import jdk.javadoc.internal.doclets.toolkit.Content;
  32 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
  33 
  34 import javax.lang.model.element.Element;
  35 import javax.lang.model.element.VariableElement;
  36 import java.util.List;
  37 
  38 /**
  39  * A taglet that represents the @param tag.
  40  *
  41  *  <p><b>This is NOT part of any supported API.
  42  *  If you write code that depends on this, you do so at your own risk.
  43  *  This code and its internal interfaces are subject to change or
  44  *  deletion without notice.</b>
  45  *
  46  * @author Jamie Ho
  47  */
  48 public class AccessorTaglet extends BaseTaglet {
  49 
  50     DocTree.Kind kind;
  51 
  52     /**
  53      * Construct a ParamTaglet.
  54      */
  55     public AccessorTaglet(DocTree.Kind kind) {
  56         super(kind.tagName, false, EnumSet.of(Site.FIELD));
  57         this.kind = kind;
  58     }
  59 
  60    /**
  61      * Given an array of <code>ParamTag</code>s,return its string representation.
  62      * @param holder the member that holds the param tags.
  63      * @param writer the TagletWriter that will write this tag.
  64      * @return the TagletOutput representation of these <code>ParamTag</code>s.
  65      */
  66     public Content getTagletOutput(Element holder, TagletWriter writer) {
  67         Utils utils = writer.configuration().utils;
  68         return writer.accessorTagOutput(holder, utils.getBlockTags(holder, kind));
  69     }
  70 }
  71