duke@1: /*
jjg@1359:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit;
duke@1: 
duke@1: import java.io.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * The interface for writing field output.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@766:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
duke@1: public interface FieldWriter {
duke@1: 
duke@1:     /**
bpatel@766:      * Get the field details tree header.
duke@1:      *
bpatel@766:      * @param classDoc the class being documented
bpatel@766:      * @param memberDetailsTree the content tree representing member details
bpatel@766:      * @return content tree for the field details header
duke@1:      */
bpatel@766:     public Content getFieldDetailsTreeHeader(ClassDoc classDoc,
bpatel@766:             Content memberDetailsTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the field documentation tree header.
duke@1:      *
bpatel@766:      * @param field the constructor being documented
bpatel@766:      * @param fieldDetailsTree the content tree representing field details
bpatel@766:      * @return content tree for the field documentation header
duke@1:      */
bpatel@766:     public Content getFieldDocTreeHeader(FieldDoc field,
bpatel@766:             Content fieldDetailsTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the signature for the given field.
duke@1:      *
bpatel@766:      * @param field the field being documented
bpatel@766:      * @return content tree for the field signature
duke@1:      */
bpatel@766:     public Content getSignature(FieldDoc field);
duke@1: 
duke@1:     /**
bpatel@766:      * Add the deprecated output for the given field.
duke@1:      *
bpatel@766:      * @param field the field being documented
bpatel@766:      * @param fieldDocTree content tree to which the deprecated information will be added
duke@1:      */
bpatel@766:     public void addDeprecated(FieldDoc field, Content fieldDocTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Add the comments for the given field.
duke@1:      *
bpatel@766:      * @param field the field being documented
bpatel@766:      * @param fieldDocTree the content tree to which the comments will be added
duke@1:      */
bpatel@766:     public void addComments(FieldDoc field, Content fieldDocTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Add the tags for the given field.
duke@1:      *
bpatel@766:      * @param field the field being documented
bpatel@766:      * @param fieldDocTree the content tree to which the tags will be added
duke@1:      */
bpatel@766:     public void addTags(FieldDoc field, Content fieldDocTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the field details tree.
bpatel@766:      *
bpatel@766:      * @param memberDetailsTree the content tree representing member details
bpatel@766:      * @return content tree for the field details
duke@1:      */
bpatel@766:     public Content getFieldDetails(Content memberDetailsTree);
duke@1: 
duke@1:     /**
bpatel@766:      * Get the field documentation.
duke@1:      *
bpatel@766:      * @param fieldDocTree the content tree representing field documentation
bpatel@766:      * @param isLastContent true if the content to be added is the last content
bpatel@766:      * @return content tree for the field documentation
duke@1:      */
bpatel@766:     public Content getFieldDoc(Content fieldDocTree, boolean isLastContent);
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException;
duke@1: }