1 /* 2 * Copyright (c) 2003, 2012, 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 com.sun.tools.doclets.internal.toolkit; 27 28 import java.io.*; 29 import com.sun.javadoc.*; 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 * @since 1.5 42 */ 43 44 public interface EnumConstantWriter { 45 46 /** 47 * Get the enum constants details tree header. 48 * 49 * @param classDoc the class being documented 50 * @param memberDetailsTree the content tree representing member details 51 * @return content tree for the enum constants details header 52 */ 53 public Content getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, 54 Content memberDetailsTree); 55 56 /** 57 * Get the enum constants documentation tree header. 58 * 59 * @param enumConstant the enum constant being documented 60 * @param enumConstantsDetailsTree the content tree representing enum constant details 61 * @return content tree for the enum constant documentation header 62 */ 63 public Content getEnumConstantsTreeHeader(FieldDoc enumConstant, 64 Content enumConstantsDetailsTree); 65 66 /** 67 * Get the signature for the given enum constant. 68 * 69 * @param enumConstant the enum constant being documented 70 * @return content tree for the enum constant signature 71 */ 72 public Content getSignature(FieldDoc enumConstant); 73 74 /** 75 * Add the deprecated output for the given enum constant. 76 * 77 * @param enumConstant the enum constant being documented 78 * @param enumConstantsTree content tree to which the deprecated information will be added 79 */ 80 public void addDeprecated(FieldDoc enumConstant, Content enumConstantsTree); 81 82 /** 83 * Add the comments for the given enum constant. 84 * 85 * @param enumConstant the enum constant being documented 86 * @param enumConstantsTree the content tree to which the comments will be added 87 */ 88 public void addComments(FieldDoc enumConstant, Content enumConstantsTree); 89 90 /** 91 * Add the tags for the given enum constant. 92 * 93 * @param enumConstant the enum constant being documented 94 * @param enumConstantsTree the content tree to which the tags will be added 95 */ 96 public void addTags(FieldDoc enumConstant, Content enumConstantsTree); 97 98 /** 99 * Get the enum constants details tree. 100 * 101 * @param memberDetailsTree the content tree representing member details 102 * @return content tree for the enum constant details 103 */ 104 public Content getEnumConstantsDetails(Content memberDetailsTree); 105 106 /** 107 * Get the enum constants documentation. 108 * 109 * @param enumConstantsTree the content tree representing enum constants documentation 110 * @param isLastContent true if the content to be added is the last content 111 * @return content tree for the enum constants documentation 112 */ 113 public Content getEnumConstants(Content enumConstantsTree, boolean isLastContent); 114 115 /** 116 * Close the writer. 117 */ 118 public void close() throws IOException; 119 }