src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java

Tue, 09 Oct 2012 19:10:00 -0700

author
jjg
date
Tue, 09 Oct 2012 19:10:00 -0700
changeset 1357
c75be5bc5283
parent 798
4868a36f6fd8
child 1359
25e14ad23cef
permissions
-rw-r--r--

8000663: clean up langtools imports
Reviewed-by: darcy

duke@1 1 /*
jjg@1357 2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.doclets.internal.toolkit.builders;
duke@1 27
bpatel@766 28 import java.util.*;
jjg@1357 29
jjg@1357 30 import com.sun.javadoc.*;
jjg@1357 31 import com.sun.tools.doclets.internal.toolkit.*;
duke@1 32 import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1 33
duke@1 34 /**
duke@1 35 * Builds documentation for optional annotation type members.
duke@1 36 *
duke@1 37 * This code is not part of an API.
duke@1 38 * It is implementation that is subject to change.
duke@1 39 * Do not use it as an API
duke@1 40 *
duke@1 41 * @author Jamie Ho
bpatel@766 42 * @author Bhavesh Patel (Modified)
duke@1 43 * @since 1.5
duke@1 44 */
duke@1 45 public class AnnotationTypeOptionalMemberBuilder extends
duke@1 46 AnnotationTypeRequiredMemberBuilder {
duke@1 47
duke@1 48
duke@1 49 /**
duke@1 50 * Construct a new AnnotationTypeMemberBuilder.
duke@1 51 *
duke@1 52 * @param configuration the current configuration of the
duke@1 53 * doclet.
duke@1 54 */
duke@1 55 private AnnotationTypeOptionalMemberBuilder(Configuration configuration) {
duke@1 56 super(configuration);
duke@1 57 }
duke@1 58
duke@1 59
duke@1 60 /**
duke@1 61 * Construct a new AnnotationTypeMemberBuilder.
duke@1 62 *
duke@1 63 * @param configuration the current configuration of the doclet.
duke@1 64 * @param classDoc the class whoses members are being documented.
duke@1 65 * @param writer the doclet specific writer.
duke@1 66 */
duke@1 67 public static AnnotationTypeOptionalMemberBuilder getInstance(
duke@1 68 Configuration configuration, ClassDoc classDoc,
duke@1 69 AnnotationTypeOptionalMemberWriter writer) {
duke@1 70 AnnotationTypeOptionalMemberBuilder builder =
duke@1 71 new AnnotationTypeOptionalMemberBuilder(configuration);
duke@1 72 builder.classDoc = classDoc;
duke@1 73 builder.writer = writer;
duke@1 74 builder.visibleMemberMap = new VisibleMemberMap(classDoc,
duke@1 75 VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL, configuration.nodeprecated);
jjg@74 76 builder.members = new ArrayList<ProgramElementDoc>(
duke@1 77 builder.visibleMemberMap.getMembersFor(classDoc));
duke@1 78 if (configuration.getMemberComparator() != null) {
duke@1 79 Collections.sort(builder.members,
duke@1 80 configuration.getMemberComparator());
duke@1 81 }
duke@1 82 return builder;
duke@1 83 }
duke@1 84
duke@1 85 /**
duke@1 86 * {@inheritDoc}
duke@1 87 */
jjg@589 88 @Override
duke@1 89 public String getName() {
duke@1 90 return "AnnotationTypeOptionalMemberDetails";
duke@1 91 }
duke@1 92
duke@1 93 /**
bpatel@766 94 * Build the annotation type optional member documentation.
duke@1 95 *
bpatel@766 96 * @param node the XML element that specifies which components to document
bpatel@766 97 * @param memberDetailsTree the content tree to which the documentation will be added
duke@1 98 */
bpatel@766 99 public void buildAnnotationTypeOptionalMember(XMLNode node, Content memberDetailsTree) {
bpatel@766 100 buildAnnotationTypeMember(node, memberDetailsTree);
duke@1 101 }
duke@1 102
duke@1 103 /**
bpatel@766 104 * Build the default value for this optional member.
bpatel@766 105 *
bpatel@766 106 * @param node the XML element that specifies which components to document
bpatel@766 107 * @param annotationDocTree the content tree to which the documentation will be added
duke@1 108 */
bpatel@766 109 public void buildDefaultValueInfo(XMLNode node, Content annotationDocTree) {
bpatel@766 110 ((AnnotationTypeOptionalMemberWriter) writer).addDefaultValueInfo(
bpatel@766 111 (MemberDoc) members.get(currentMemberIndex),
bpatel@766 112 annotationDocTree);
duke@1 113 }
duke@1 114
duke@1 115 /**
duke@1 116 * {@inheritDoc}
duke@1 117 */
jjg@589 118 @Override
duke@1 119 public AnnotationTypeRequiredMemberWriter getWriter() {
duke@1 120 return writer;
duke@1 121 }
duke@1 122 }

mercurial