duke@1: /*
jjg@1357:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.builders;
duke@1: 
bpatel@766: import java.util.*;
jjg@1357: 
jjg@1357: import com.sun.javadoc.*;
jjg@1357: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * Builds documentation for optional annotation type members.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
duke@1:  *
duke@1:  * @author Jamie Ho
bpatel@766:  * @author Bhavesh Patel (Modified)
duke@1:  * @since 1.5
duke@1:  */
duke@1: public class AnnotationTypeOptionalMemberBuilder extends
duke@1:     AnnotationTypeRequiredMemberBuilder {
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Construct a new AnnotationTypeMemberBuilder.
duke@1:      *
duke@1:      * @param configuration the current configuration of the
duke@1:      *                      doclet.
duke@1:      */
duke@1:     private AnnotationTypeOptionalMemberBuilder(Configuration configuration) {
duke@1:         super(configuration);
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Construct a new AnnotationTypeMemberBuilder.
duke@1:      *
duke@1:      * @param configuration the current configuration of the doclet.
duke@1:      * @param classDoc the class whoses members are being documented.
duke@1:      * @param writer the doclet specific writer.
duke@1:      */
duke@1:     public static AnnotationTypeOptionalMemberBuilder getInstance(
duke@1:             Configuration configuration, ClassDoc classDoc,
duke@1:             AnnotationTypeOptionalMemberWriter writer) {
duke@1:         AnnotationTypeOptionalMemberBuilder builder =
duke@1:             new AnnotationTypeOptionalMemberBuilder(configuration);
duke@1:         builder.classDoc = classDoc;
duke@1:         builder.writer = writer;
duke@1:         builder.visibleMemberMap = new VisibleMemberMap(classDoc,
duke@1:             VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL, configuration.nodeprecated);
jjg@74:         builder.members = new ArrayList<ProgramElementDoc>(
duke@1:             builder.visibleMemberMap.getMembersFor(classDoc));
duke@1:         if (configuration.getMemberComparator() != null) {
duke@1:             Collections.sort(builder.members,
duke@1:                 configuration.getMemberComparator());
duke@1:         }
duke@1:         return builder;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
jjg@589:     @Override
duke@1:     public String getName() {
duke@1:         return "AnnotationTypeOptionalMemberDetails";
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the annotation type optional member documentation.
duke@1:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param memberDetailsTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildAnnotationTypeOptionalMember(XMLNode node, Content memberDetailsTree) {
bpatel@766:         buildAnnotationTypeMember(node, memberDetailsTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Build the default value for this optional member.
bpatel@766:      *
bpatel@766:      * @param node the XML element that specifies which components to document
bpatel@766:      * @param annotationDocTree the content tree to which the documentation will be added
duke@1:      */
bpatel@766:     public void buildDefaultValueInfo(XMLNode node, Content annotationDocTree) {
bpatel@766:         ((AnnotationTypeOptionalMemberWriter) writer).addDefaultValueInfo(
bpatel@766:                 (MemberDoc) members.get(currentMemberIndex),
bpatel@766:                 annotationDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
jjg@589:     @Override
duke@1:     public AnnotationTypeRequiredMemberWriter getWriter() {
duke@1:         return writer;
duke@1:     }
duke@1: }