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