Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java@522a1ee72340 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java
Mon, 19 Nov 2012 16:10:34 -0800
- author
- bpatel
- date
- Mon, 19 Nov 2012 16:10:34 -0800
- changeset 1417
- 522a1ee72340
- parent 1410
- bfec2a1cc869
- child 1985
- 0e6577980181
- permissions
- -rw-r--r--
8002304: Group methods by types in methods summary section
Reviewed-by: jjg
| duke@1 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 2003, 2012, 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 | |
| jjg@1410 | 28 | import java.util.Set; |
| jjg@1410 | 29 | |
| duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.*; |
| duke@1 | 31 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * The superclass for all member builders. Member builders are only executed |
| duke@1 | 35 | * within Class Builders. They essentially build sub-components. For example, |
| duke@1 | 36 | * method documentation is a sub-component of class documentation. |
| duke@1 | 37 | * |
| jjg@1359 | 38 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 39 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 40 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 41 | * deletion without notice.</b> |
| duke@1 | 42 | * |
| duke@1 | 43 | * @author Jamie Ho |
| duke@1 | 44 | * @since 1.5 |
| duke@1 | 45 | */ |
| duke@1 | 46 | public abstract class AbstractMemberBuilder extends AbstractBuilder { |
| duke@1 | 47 | |
| duke@1 | 48 | /** |
| duke@1 | 49 | * Construct a SubBuilder. |
| duke@1 | 50 | * @param configuration the configuration used in this run |
| duke@1 | 51 | * of the doclet. |
| duke@1 | 52 | */ |
| jjg@1410 | 53 | public AbstractMemberBuilder(Context context) { |
| jjg@1410 | 54 | super(context); |
| duke@1 | 55 | } |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * This method is not supported by sub-builders. |
| duke@1 | 59 | * |
| duke@1 | 60 | * @throws DocletAbortException this method will always throw a |
| duke@1 | 61 | * DocletAbortException because it is not supported. |
| duke@1 | 62 | */ |
| duke@1 | 63 | public void build() throws DocletAbortException { |
| duke@1 | 64 | //You may not call the build method in a subbuilder. |
| duke@1 | 65 | throw new DocletAbortException(); |
| duke@1 | 66 | } |
| duke@1 | 67 | |
| duke@1 | 68 | |
| duke@1 | 69 | /** |
| duke@1 | 70 | * Build the sub component if there is anything to document. |
| duke@1 | 71 | * |
| bpatel@766 | 72 | * @param node the XML element that specifies which components to document. |
| bpatel@766 | 73 | * @param contentTree content tree to which the documentation will be added |
| duke@1 | 74 | */ |
| jjg@589 | 75 | @Override |
| bpatel@766 | 76 | public void build(XMLNode node, Content contentTree) { |
| duke@1 | 77 | if (hasMembersToDocument()) { |
| bpatel@766 | 78 | super.build(node, contentTree); |
| duke@1 | 79 | } |
| duke@1 | 80 | } |
| duke@1 | 81 | |
| duke@1 | 82 | /** |
| duke@1 | 83 | * Return true if this subbuilder has anything to document. |
| duke@1 | 84 | * |
| duke@1 | 85 | * @return true if this subbuilder has anything to document. |
| duke@1 | 86 | */ |
| duke@1 | 87 | public abstract boolean hasMembersToDocument(); |
| duke@1 | 88 | } |
