Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java@4177f5bdd189 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AnnotationTypeOptionalMemberBuilder.java
Fri, 18 Jun 2010 21:13:56 -0700
- author
- jjg
- date
- Fri, 18 Jun 2010 21:13:56 -0700
- changeset 589
- 4177f5bdd189
- parent 554
- 9d9f26857129
- child 766
- 90af8d87741f
- permissions
- -rw-r--r--
6961178: Allow doclet.xml to contain XML attributes
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2003, 2008, 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 | |
| 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 | |
| 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 |
| duke@1 | 42 | * @since 1.5 |
| duke@1 | 43 | */ |
| duke@1 | 44 | public class AnnotationTypeOptionalMemberBuilder extends |
| duke@1 | 45 | AnnotationTypeRequiredMemberBuilder { |
| duke@1 | 46 | |
| duke@1 | 47 | |
| duke@1 | 48 | /** |
| duke@1 | 49 | * Construct a new AnnotationTypeMemberBuilder. |
| duke@1 | 50 | * |
| duke@1 | 51 | * @param configuration the current configuration of the |
| duke@1 | 52 | * doclet. |
| duke@1 | 53 | */ |
| duke@1 | 54 | private AnnotationTypeOptionalMemberBuilder(Configuration configuration) { |
| duke@1 | 55 | super(configuration); |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | |
| duke@1 | 59 | /** |
| duke@1 | 60 | * Construct a new AnnotationTypeMemberBuilder. |
| duke@1 | 61 | * |
| duke@1 | 62 | * @param configuration the current configuration of the doclet. |
| duke@1 | 63 | * @param classDoc the class whoses members are being documented. |
| duke@1 | 64 | * @param writer the doclet specific writer. |
| duke@1 | 65 | */ |
| duke@1 | 66 | public static AnnotationTypeOptionalMemberBuilder getInstance( |
| duke@1 | 67 | Configuration configuration, ClassDoc classDoc, |
| duke@1 | 68 | AnnotationTypeOptionalMemberWriter writer) { |
| duke@1 | 69 | AnnotationTypeOptionalMemberBuilder builder = |
| duke@1 | 70 | new AnnotationTypeOptionalMemberBuilder(configuration); |
| duke@1 | 71 | builder.classDoc = classDoc; |
| duke@1 | 72 | builder.writer = writer; |
| duke@1 | 73 | builder.visibleMemberMap = new VisibleMemberMap(classDoc, |
| duke@1 | 74 | VisibleMemberMap.ANNOTATION_TYPE_MEMBER_OPTIONAL, configuration.nodeprecated); |
| jjg@74 | 75 | builder.members = new ArrayList<ProgramElementDoc>( |
| duke@1 | 76 | builder.visibleMemberMap.getMembersFor(classDoc)); |
| duke@1 | 77 | if (configuration.getMemberComparator() != null) { |
| duke@1 | 78 | Collections.sort(builder.members, |
| duke@1 | 79 | configuration.getMemberComparator()); |
| duke@1 | 80 | } |
| duke@1 | 81 | return builder; |
| duke@1 | 82 | } |
| duke@1 | 83 | |
| duke@1 | 84 | /** |
| duke@1 | 85 | * {@inheritDoc} |
| duke@1 | 86 | */ |
| jjg@589 | 87 | @Override |
| 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 | */ |
| jjg@589 | 98 | public void buildAnnotationTypeOptionalMember(XMLNode node) { |
| 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++) { |
| jjg@589 | 104 | buildChildren(node); |
| duke@1 | 105 | } |
| duke@1 | 106 | } |
| duke@1 | 107 | |
| duke@1 | 108 | /** |
| duke@1 | 109 | * Document the default value for this optional member. |
| duke@1 | 110 | */ |
| jjg@589 | 111 | public void buildDefaultValueInfo(XMLNode node) { |
| duke@1 | 112 | ((AnnotationTypeOptionalMemberWriter) writer).writeDefaultValueInfo( |
| duke@1 | 113 | (MemberDoc) members.get(currentMemberIndex)); |
| duke@1 | 114 | } |
| duke@1 | 115 | |
| duke@1 | 116 | /** |
| duke@1 | 117 | * {@inheritDoc} |
| duke@1 | 118 | */ |
| jjg@589 | 119 | @Override |
| duke@1 | 120 | public AnnotationTypeRequiredMemberWriter getWriter() { |
| duke@1 | 121 | return writer; |
| duke@1 | 122 | } |
| duke@1 | 123 | } |
