1 /*
   2  * Copyright (c) 2003, 2016, 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;
  27 
  28 import javax.lang.model.element.TypeElement;
  29 import javax.lang.model.element.VariableElement;
  30 
  31 /**
  32  * The interface for writing enum constant output.
  33  *
  34  *  <p><b>This is NOT part of any supported API.
  35  *  If you write code that depends on this, you do so at your own risk.
  36  *  This code and its internal interfaces are subject to change or
  37  *  deletion without notice.</b>
  38  *
  39  * @author Jamie Ho
  40  * @author Bhavesh Patel (Modified)
  41  */
  42 
  43 public interface EnumConstantWriter {
  44 
  45     /**
  46      * Get the enum constants details tree header.
  47      *
  48      * @param typeElement the class being documented
  49      * @param memberDetailsTree the content tree representing member details
  50      * @return content tree for the enum constants details header
  51      */
  52     public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
  53             Content memberDetailsTree);
  54 
  55     /**
  56      * Get the enum constants documentation tree header.
  57      *
  58      * @param enumConstant the enum constant being documented
  59      * @param enumConstantsDetailsTree the content tree representing enum constant details
  60      * @return content tree for the enum constant documentation header
  61      */
  62     public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
  63             Content enumConstantsDetailsTree);
  64 
  65     /**
  66      * Get the signature for the given enum constant.
  67      *
  68      * @param enumConstant the enum constant being documented
  69      * @return content tree for the enum constant signature
  70      */
  71     public Content getSignature(VariableElement enumConstant);
  72 
  73     /**
  74      * Add the deprecated output for the given enum constant.
  75      *
  76      * @param enumConstant the enum constant being documented
  77      * @param enumConstantsTree content tree to which the deprecated information will be added
  78      */
  79     public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree);
  80 
  81     /**
  82      * Add the comments for the given enum constant.
  83      *
  84      * @param enumConstant the enum constant being documented
  85      * @param enumConstantsTree the content tree to which the comments will be added
  86      */
  87     public void addComments(VariableElement enumConstant, Content enumConstantsTree);
  88 
  89     /**
  90      * Add the tags for the given enum constant.
  91      *
  92      * @param enumConstant the enum constant being documented
  93      * @param enumConstantsTree the content tree to which the tags will be added
  94      */
  95     public void addTags(VariableElement enumConstant, Content enumConstantsTree);
  96 
  97     /**
  98      * Get the enum constants details tree.
  99      *
 100      * @param memberDetailsTree the content tree representing member details
 101      * @return content tree for the enum constant details
 102      */
 103     public Content getEnumConstantsDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
 104 
 105     /**
 106      * Get the enum constants documentation.
 107      *
 108      * @param enumConstantsTree the content tree representing enum constants documentation
 109      * @return content tree for the enum constants documentation
 110      */
 111     public Content getEnumConstants(Content enumConstantsTree);
 112 
 113     /**
 114      * Gets the member header tree.
 115      *
 116      * @return a content tree for the member header
 117      */
 118     public Content getMemberTreeHeader();
 119 }