1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/PropertyWriter.java Sun Feb 24 11:36:58 2013 -0800
1.3 @@ -0,0 +1,119 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit;
1.30 +
1.31 +import java.io.*;
1.32 +import com.sun.javadoc.*;
1.33 +
1.34 +/**
1.35 + * The interface for writing property output.
1.36 + *
1.37 + * <p><b>This is NOT part of any supported API.
1.38 + * If you write code that depends on this, you do so at your own risk.
1.39 + * This code and its internal interfaces are subject to change or
1.40 + * deletion without notice.</b>
1.41 + *
1.42 + * @author Jamie Ho
1.43 + * @author Bhavesh Patel (Modified)
1.44 + * @since 1.7
1.45 + */
1.46 +
1.47 +public interface PropertyWriter {
1.48 +
1.49 + /**
1.50 + * Get the property details tree header.
1.51 + *
1.52 + * @param classDoc the class being documented
1.53 + * @param memberDetailsTree the content tree representing member details
1.54 + * @return content tree for the property details header
1.55 + */
1.56 + public Content getPropertyDetailsTreeHeader(ClassDoc classDoc,
1.57 + Content memberDetailsTree);
1.58 +
1.59 + /**
1.60 + * Get the property documentation tree header.
1.61 + *
1.62 + * @param property the property being documented
1.63 + * @param propertyDetailsTree the content tree representing property details
1.64 + * @return content tree for the property documentation header
1.65 + */
1.66 + public Content getPropertyDocTreeHeader(MethodDoc property,
1.67 + Content propertyDetailsTree);
1.68 +
1.69 + /**
1.70 + * Get the signature for the given property.
1.71 + *
1.72 + * @param property the property being documented
1.73 + * @return content tree for the property signature
1.74 + */
1.75 + public Content getSignature(MethodDoc property);
1.76 +
1.77 + /**
1.78 + * Add the deprecated output for the given property.
1.79 + *
1.80 + * @param property the property being documented
1.81 + * @param propertyDocTree content tree to which the deprecated information will be added
1.82 + */
1.83 + public void addDeprecated(MethodDoc property, Content propertyDocTree);
1.84 +
1.85 + /**
1.86 + * Add the comments for the given property.
1.87 + *
1.88 + * @param property the property being documented
1.89 + * @param propertyDocTree the content tree to which the comments will be added
1.90 + */
1.91 + public void addComments(MethodDoc property, Content propertyDocTree);
1.92 +
1.93 + /**
1.94 + * Add the tags for the given property.
1.95 + *
1.96 + * @param property the property being documented
1.97 + * @param propertyDocTree the content tree to which the tags will be added
1.98 + */
1.99 + public void addTags(MethodDoc property, Content propertyDocTree);
1.100 +
1.101 + /**
1.102 + * Get the property details tree.
1.103 + *
1.104 + * @param memberDetailsTree the content tree representing member details
1.105 + * @return content tree for the property details
1.106 + */
1.107 + public Content getPropertyDetails(Content memberDetailsTree);
1.108 +
1.109 + /**
1.110 + * Get the property documentation.
1.111 + *
1.112 + * @param propertyDocTree the content tree representing property documentation
1.113 + * @param isLastContent true if the content to be added is the last content
1.114 + * @return content tree for the property documentation
1.115 + */
1.116 + public Content getPropertyDoc(Content propertyDocTree, boolean isLastContent);
1.117 +
1.118 + /**
1.119 + * Close the writer.
1.120 + */
1.121 + public void close() throws IOException;
1.122 +}
