Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java@4177f5bdd189 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.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, 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 | import com.sun.tools.doclets.internal.toolkit.*; |
| duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * The superclass for all member builders. Member builders are only executed |
| duke@1 | 33 | * within Class Builders. They essentially build sub-components. For example, |
| duke@1 | 34 | * method documentation is a sub-component of class documentation. |
| duke@1 | 35 | * |
| duke@1 | 36 | * This code is not part of an API. |
| duke@1 | 37 | * It is implementation that is subject to change. |
| duke@1 | 38 | * Do not use it as an API |
| duke@1 | 39 | * |
| duke@1 | 40 | * @author Jamie Ho |
| duke@1 | 41 | * @since 1.5 |
| duke@1 | 42 | */ |
| duke@1 | 43 | public abstract class AbstractMemberBuilder extends AbstractBuilder { |
| duke@1 | 44 | |
| duke@1 | 45 | /** |
| duke@1 | 46 | * Construct a SubBuilder. |
| duke@1 | 47 | * @param configuration the configuration used in this run |
| duke@1 | 48 | * of the doclet. |
| duke@1 | 49 | */ |
| duke@1 | 50 | public AbstractMemberBuilder(Configuration configuration) { |
| duke@1 | 51 | super(configuration); |
| duke@1 | 52 | } |
| duke@1 | 53 | |
| duke@1 | 54 | /** |
| duke@1 | 55 | * This method is not supported by sub-builders. |
| duke@1 | 56 | * |
| duke@1 | 57 | * @throws DocletAbortException this method will always throw a |
| duke@1 | 58 | * DocletAbortException because it is not supported. |
| duke@1 | 59 | */ |
| duke@1 | 60 | public void build() throws DocletAbortException { |
| duke@1 | 61 | //You may not call the build method in a subbuilder. |
| duke@1 | 62 | throw new DocletAbortException(); |
| duke@1 | 63 | } |
| duke@1 | 64 | |
| duke@1 | 65 | |
| duke@1 | 66 | /** |
| duke@1 | 67 | * Build the sub component if there is anything to document. |
| duke@1 | 68 | * |
| duke@1 | 69 | * @param elements {@inheritDoc} |
| duke@1 | 70 | */ |
| jjg@589 | 71 | @Override |
| jjg@589 | 72 | public void build(XMLNode node) { |
| duke@1 | 73 | if (hasMembersToDocument()) { |
| jjg@589 | 74 | super.build(node); |
| duke@1 | 75 | } |
| duke@1 | 76 | } |
| duke@1 | 77 | |
| duke@1 | 78 | /** |
| duke@1 | 79 | * Return true if this subbuilder has anything to document. |
| duke@1 | 80 | * |
| duke@1 | 81 | * @return true if this subbuilder has anything to document. |
| duke@1 | 82 | */ |
| duke@1 | 83 | public abstract boolean hasMembersToDocument(); |
| duke@1 | 84 | } |
