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

Thu, 02 Oct 2008 19:58:40 -0700

author
xdono
date
Thu, 02 Oct 2008 19:58:40 -0700
changeset 117
24a47c3062fe
parent 74
5a9172b251dd
child 184
905e151a185a
permissions
-rw-r--r--

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

duke@1 1 /*
xdono@117 2 * Copyright 2003-2008 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.doclets.internal.toolkit.builders;
duke@1 27
duke@1 28
duke@1 29 import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1 30 import com.sun.tools.doclets.internal.toolkit.*;
duke@1 31 import com.sun.javadoc.*;
duke@1 32 import java.util.*;
duke@1 33 import java.lang.reflect.*;
duke@1 34
duke@1 35 /**
duke@1 36 * Builds documentation for optional annotation type members.
duke@1 37 *
duke@1 38 * This code is not part of an API.
duke@1 39 * It is implementation that is subject to change.
duke@1 40 * Do not use it as an API
duke@1 41 *
duke@1 42 * @author Jamie Ho
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 */
duke@1 88 public String getName() {
duke@1 89 return "AnnotationTypeOptionalMemberDetails";
duke@1 90 }
duke@1 91
duke@1 92 /**
duke@1 93 * Build the member documentation.
duke@1 94 *
duke@1 95 * @param elements the XML elements that specify how to construct this
duke@1 96 * documentation.
duke@1 97 */
duke@1 98 public void buildAnnotationTypeOptionalMember(List elements) {
duke@1 99 if (writer == null) {
duke@1 100 return;
duke@1 101 }
duke@1 102 for (currentMemberIndex = 0; currentMemberIndex < members.size();
duke@1 103 currentMemberIndex++) {
duke@1 104 build(elements);
duke@1 105 }
duke@1 106 }
duke@1 107
duke@1 108 /**
duke@1 109 * {@inheritDoc}
duke@1 110 */
duke@1 111 public void invokeMethod(String methodName, Class[] paramClasses,
duke@1 112 Object[] params)
duke@1 113 throws Exception {
duke@1 114 if (DEBUG) {
duke@1 115 configuration.root.printError("DEBUG: " + this.getClass().getName()
duke@1 116 + "." + methodName);
duke@1 117 }
duke@1 118 Method method = this.getClass().getMethod(methodName, paramClasses);
duke@1 119 method.invoke(this, params);
duke@1 120 }
duke@1 121
duke@1 122 /**
duke@1 123 * Document the default value for this optional member.
duke@1 124 */
duke@1 125 public void buildDefaultValueInfo() {
duke@1 126 ((AnnotationTypeOptionalMemberWriter) writer).writeDefaultValueInfo(
duke@1 127 (MemberDoc) members.get(currentMemberIndex));
duke@1 128 }
duke@1 129
duke@1 130 /**
duke@1 131 * {@inheritDoc}
duke@1 132 */
duke@1 133 public AnnotationTypeRequiredMemberWriter getWriter() {
duke@1 134 return writer;
duke@1 135 }
duke@1 136 }

mercurial