AnnotationTypeOptionalMemberBuilder.java revision 553
0N/A/*
553N/A * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.internal.toolkit.builders;
0N/A
0N/A
0N/Aimport com.sun.tools.doclets.internal.toolkit.util.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.*;
0N/Aimport com.sun.javadoc.*;
0N/Aimport java.util.*;
0N/Aimport java.lang.reflect.*;
0N/A
0N/A/**
0N/A * Builds documentation for optional annotation type members.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
0N/A * @since 1.5
0N/A */
0N/Apublic class AnnotationTypeOptionalMemberBuilder extends
0N/A AnnotationTypeRequiredMemberBuilder {
0N/A
0N/A
0N/A /**
0N/A * Construct a new AnnotationTypeMemberBuilder.
0N/A *
0N/A * @param configuration the current configuration of the
0N/A * doclet.
0N/A */
0N/A private AnnotationTypeOptionalMemberBuilder(Configuration configuration) {
0N/A super(configuration);
0N/A }
0N/A
0N/A
0N/A /**
0N/A * Construct a new AnnotationTypeMemberBuilder.
0N/A *
0N/A * @param configuration the current configuration of the doclet.
0N/A * @param classDoc the class whoses members are being documented.
0N/A * @param writer the doclet specific writer.
0N/A */
0N/A public static AnnotationTypeOptionalMemberBuilder getInstance(
0N/A Configuration configuration, ClassDoc classDoc,
0N/A AnnotationTypeOptionalMemberWriter writer) {
0N/A AnnotationTypeOptionalMemberBuilder builder =
0N/A new AnnotationTypeOptionalMemberBuilder(configuration);
0N/A builder.classDoc = classDoc;
0N/A builder.writer = writer;
0N/A builder.visibleMemberMap = new VisibleMemberMap(classDoc,
0N/A VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL, configuration.nodeprecated);
73N/A builder.members = new ArrayList<ProgramElementDoc>(
0N/A builder.visibleMemberMap.getMembersFor(classDoc));
0N/A if (configuration.getMemberComparator() != null) {
0N/A Collections.sort(builder.members,
0N/A configuration.getMemberComparator());
0N/A }
0N/A return builder;
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A */
0N/A public String getName() {
0N/A return "AnnotationTypeOptionalMemberDetails";
0N/A }
0N/A
0N/A /**
0N/A * Build the member documentation.
0N/A *
0N/A * @param elements the XML elements that specify how to construct this
0N/A * documentation.
0N/A */
183N/A public void buildAnnotationTypeOptionalMember(List<?> elements) {
0N/A if (writer == null) {
0N/A return;
0N/A }
0N/A for (currentMemberIndex = 0; currentMemberIndex < members.size();
0N/A currentMemberIndex++) {
0N/A build(elements);
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A */
183N/A public void invokeMethod(String methodName, Class<?>[] paramClasses,
0N/A Object[] params)
0N/A throws Exception {
0N/A if (DEBUG) {
0N/A configuration.root.printError("DEBUG: " + this.getClass().getName()
0N/A + "." + methodName);
0N/A }
0N/A Method method = this.getClass().getMethod(methodName, paramClasses);
0N/A method.invoke(this, params);
0N/A }
0N/A
0N/A /**
0N/A * Document the default value for this optional member.
0N/A */
0N/A public void buildDefaultValueInfo() {
0N/A ((AnnotationTypeOptionalMemberWriter) writer).writeDefaultValueInfo(
0N/A (MemberDoc) members.get(currentMemberIndex));
0N/A }
0N/A
0N/A /**
0N/A * {@inheritDoc}
0N/A */
0N/A public AnnotationTypeRequiredMemberWriter getWriter() {
0N/A return writer;
0N/A }
0N/A}