< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/PropertyBuilder.java

Print this page




  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 jdk.javadoc.internal.doclets.toolkit.builders;
  27 
  28 import java.util.*;
  29 
  30 import javax.lang.model.element.Element;
  31 import javax.lang.model.element.ExecutableElement;
  32 import javax.lang.model.element.TypeElement;
  33 
  34 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
  35 import jdk.javadoc.internal.doclets.toolkit.Content;
  36 import jdk.javadoc.internal.doclets.toolkit.DocletException;
  37 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
  38 
  39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
  40 
  41 /**
  42  * Builds documentation for a property.
  43  *
  44  *  <p><b>This is NOT part of any supported API.
  45  *  If you write code that depends on this, you do so at your own risk.
  46  *  This code and its internal interfaces are subject to change or
  47  *  deletion without notice.</b>
  48  */
  49 public class PropertyBuilder extends AbstractMemberBuilder {
  50 
  51     /**
  52      * The writer to output the property documentation.
  53      */
  54     private final PropertyWriter writer;


 143     /**
 144      * Build the signature.
 145      *
 146      * @param propertyDocTree the content tree to which the documentation will be added
 147      */
 148     protected void buildSignature(Content propertyDocTree) {
 149         propertyDocTree.add(writer.getSignature(currentProperty));
 150     }
 151 
 152     /**
 153      * Build the deprecation information.
 154      *
 155      * @param propertyDocTree the content tree to which the documentation will be added
 156      */
 157     protected void buildDeprecationInfo(Content propertyDocTree) {
 158         writer.addDeprecated(currentProperty, propertyDocTree);
 159     }
 160 
 161     /**
 162      * Build the comments for the property.  Do nothing if
 163      * {@link BaseConfiguration#nocomment} is set to true.
 164      *
 165      * @param propertyDocTree the content tree to which the documentation will be added
 166      */
 167     protected void buildPropertyComments(Content propertyDocTree) {
 168         if (!configuration.nocomment) {
 169             writer.addComments(currentProperty, propertyDocTree);
 170         }
 171     }
 172 
 173     /**
 174      * Build the tag information.
 175      *
 176      * @param propertyDocTree the content tree to which the documentation will be added
 177      */
 178     protected void buildTagInfo(Content propertyDocTree) {
 179         writer.addTags(currentProperty, propertyDocTree);
 180     }
 181 
 182     /**
 183      * Return the property writer for this builder.
 184      *
 185      * @return the property writer for this builder.
 186      */
 187     public PropertyWriter getWriter() {
 188         return writer;


  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 jdk.javadoc.internal.doclets.toolkit.builders;
  27 
  28 import java.util.*;
  29 
  30 import javax.lang.model.element.Element;
  31 import javax.lang.model.element.ExecutableElement;
  32 import javax.lang.model.element.TypeElement;
  33 
  34 import jdk.javadoc.internal.doclets.toolkit.BaseOptions;
  35 import jdk.javadoc.internal.doclets.toolkit.Content;
  36 import jdk.javadoc.internal.doclets.toolkit.DocletException;
  37 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
  38 
  39 import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*;
  40 
  41 /**
  42  * Builds documentation for a property.
  43  *
  44  *  <p><b>This is NOT part of any supported API.
  45  *  If you write code that depends on this, you do so at your own risk.
  46  *  This code and its internal interfaces are subject to change or
  47  *  deletion without notice.</b>
  48  */
  49 public class PropertyBuilder extends AbstractMemberBuilder {
  50 
  51     /**
  52      * The writer to output the property documentation.
  53      */
  54     private final PropertyWriter writer;


 143     /**
 144      * Build the signature.
 145      *
 146      * @param propertyDocTree the content tree to which the documentation will be added
 147      */
 148     protected void buildSignature(Content propertyDocTree) {
 149         propertyDocTree.add(writer.getSignature(currentProperty));
 150     }
 151 
 152     /**
 153      * Build the deprecation information.
 154      *
 155      * @param propertyDocTree the content tree to which the documentation will be added
 156      */
 157     protected void buildDeprecationInfo(Content propertyDocTree) {
 158         writer.addDeprecated(currentProperty, propertyDocTree);
 159     }
 160 
 161     /**
 162      * Build the comments for the property.  Do nothing if
 163      * {@link BaseOptions#noComment} is set to true.
 164      *
 165      * @param propertyDocTree the content tree to which the documentation will be added
 166      */
 167     protected void buildPropertyComments(Content propertyDocTree) {
 168         if (!options.noComment) {
 169             writer.addComments(currentProperty, propertyDocTree);
 170         }
 171     }
 172 
 173     /**
 174      * Build the tag information.
 175      *
 176      * @param propertyDocTree the content tree to which the documentation will be added
 177      */
 178     protected void buildTagInfo(Content propertyDocTree) {
 179         writer.addTags(currentProperty, propertyDocTree);
 180     }
 181 
 182     /**
 183      * Return the property writer for this builder.
 184      *
 185      * @return the property writer for this builder.
 186      */
 187     public PropertyWriter getWriter() {
 188         return writer;
< prev index next >