Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
equal
deleted
inserted
replaced
| -1:000000000000 | 0:959103a6100f |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. | |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 * | |
| 5 * This code is free software; you can redistribute it and/or modify it | |
| 6 * under the terms of the GNU General Public License version 2 only, as | |
| 7 * published by the Free Software Foundation. Oracle designates this | |
| 8 * particular file as subject to the "Classpath" exception as provided | |
| 9 * by Oracle in the LICENSE file that accompanied this code. | |
| 10 * | |
| 11 * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 * accompanied this code). | |
| 16 * | |
| 17 * You should have received a copy of the GNU General Public License version | |
| 18 * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 * | |
| 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 * or visit www.oracle.com if you need additional information or have any | |
| 23 * questions. | |
| 24 */ | |
| 25 | |
| 26 package com.sun.tools.doclets.internal.toolkit.builders; | |
| 27 | |
| 28 import java.util.Set; | |
| 29 | |
| 30 import com.sun.tools.doclets.internal.toolkit.*; | |
| 31 import com.sun.tools.doclets.internal.toolkit.util.*; | |
| 32 | |
| 33 /** | |
| 34 * The superclass for all member builders. Member builders are only executed | |
| 35 * within Class Builders. They essentially build sub-components. For example, | |
| 36 * method documentation is a sub-component of class documentation. | |
| 37 * | |
| 38 * <p><b>This is NOT part of any supported API. | |
| 39 * If you write code that depends on this, you do so at your own risk. | |
| 40 * This code and its internal interfaces are subject to change or | |
| 41 * deletion without notice.</b> | |
| 42 * | |
| 43 * @author Jamie Ho | |
| 44 * @since 1.5 | |
| 45 */ | |
| 46 public abstract class AbstractMemberBuilder extends AbstractBuilder { | |
| 47 | |
| 48 /** | |
| 49 * Construct a SubBuilder. | |
| 50 * @param configuration the configuration used in this run | |
| 51 * of the doclet. | |
| 52 */ | |
| 53 public AbstractMemberBuilder(Context context) { | |
| 54 super(context); | |
| 55 } | |
| 56 | |
| 57 /** | |
| 58 * This method is not supported by sub-builders. | |
| 59 * | |
| 60 * @throws DocletAbortException this method will always throw a | |
| 61 * DocletAbortException because it is not supported. | |
| 62 */ | |
| 63 public void build() throws DocletAbortException { | |
| 64 //You may not call the build method in a subbuilder. | |
| 65 throw new DocletAbortException("not supported"); | |
| 66 } | |
| 67 | |
| 68 | |
| 69 /** | |
| 70 * Build the sub component if there is anything to document. | |
| 71 * | |
| 72 * @param node the XML element that specifies which components to document. | |
| 73 * @param contentTree content tree to which the documentation will be added | |
| 74 */ | |
| 75 @Override | |
| 76 public void build(XMLNode node, Content contentTree) { | |
| 77 if (hasMembersToDocument()) { | |
| 78 super.build(node, contentTree); | |
| 79 } | |
| 80 } | |
| 81 | |
| 82 /** | |
| 83 * Return true if this subbuilder has anything to document. | |
| 84 * | |
| 85 * @return true if this subbuilder has anything to document. | |
| 86 */ | |
| 87 public abstract boolean hasMembersToDocument(); | |
| 88 } |
