jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java@25e14ad23cef (annotated)

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

Wed, 10 Oct 2012 16:48:21 -0700

author: jjg
date: Wed, 10 Oct 2012 16:48:21 -0700
changeset 1359: 25e14ad23cef
parent 1357: c75be5bc5283
child 1410: bfec2a1cc869
permissions: -rw-r--r--

8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy

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

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java@25e14ad23cef (annotated)

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