001/*
002 * Copyright (c) 2003, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.toolkit;
027
028import javax.lang.model.element.TypeElement;
029import javax.lang.model.element.VariableElement;
030
031/**
032 * The interface for writing enum constant output.
033 */
034public interface EnumConstantWriter extends MemberWriter {
035
036    /**
037     * Get the enum constants details header.
038     *
039     * @param typeElement the class being documented
040     * @param memberDetails the content representing member details
041     * @return a content for the enum constants details header
042     */
043    Content getEnumConstantsDetailsHeader(TypeElement typeElement,
044            Content memberDetails);
045
046    /**
047     * Get the enum constants documentation header.
048     *
049     * @param enumConstant the enum constant being documented
050     * @param enumConstantsDetails the content representing enum constant details
051     * @return the enum constant documentation header
052     */
053    Content getEnumConstantsHeader(VariableElement enumConstant,
054            Content enumConstantsDetails);
055
056    /**
057     * Get the signature for the given enum constant.
058     *
059     * @param enumConstant the enum constant being documented
060     * @return the enum constant signature
061     */
062    Content getSignature(VariableElement enumConstant);
063
064    /**
065     * Add the deprecated output for the given enum constant.
066     *
067     * @param enumConstant the enum constant being documented
068     * @param content the content to which the deprecated information will be added
069     */
070    void addDeprecated(VariableElement enumConstant, Content content);
071
072    /**
073     * Add the preview output for the given member.
074     *
075     * @param member the member being documented
076     * @param content the content to which the preview information will be added
077     */
078    void addPreview(VariableElement member, Content content);
079
080    /**
081     * Add the comments for the given enum constant.
082     *
083     * @param enumConstant the enum constant being documented
084     * @param enumConstants the content to which the comments will be added
085     */
086    void addComments(VariableElement enumConstant, Content enumConstants);
087
088    /**
089     * Add the tags for the given enum constant.
090     *
091     * @param enumConstant the enum constant being documented
092     * @param content the content to which the tags will be added
093     */
094    void addTags(VariableElement enumConstant, Content content);
095
096    /**
097     * Get the enum constants details.
098     *
099     * @param memberDetailsHeader member details header
100     * @param content the content representing member details
101     * @return the enum constant details
102     */
103    Content getEnumConstantsDetails(Content memberDetailsHeader,
104            Content content);
105
106    /**
107     * Gets the member header.
108     *
109     * @return the member header
110     */
111    Content getMemberHeader();
112}