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

Tue, 13 Jan 2009 13:27:14 +0000

author
mcimadamore
date
Tue, 13 Jan 2009 13:27:14 +0000
changeset 184
905e151a185a
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6765045: Remove rawtypes warnings from langtools
Summary: Removed all occurrences of rawtypes warnings from langtools
Reviewed-by: jjg, bpatel

     1 /*
     2  * Copyright 2003 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package com.sun.tools.doclets.internal.toolkit.builders;
    28 import com.sun.tools.doclets.internal.toolkit.*;
    29 import com.sun.tools.doclets.internal.toolkit.util.*;
    30 import java.util.*;
    32 /**
    33  * The superclass for all member builders.  Member builders are only executed
    34  * within Class Builders.  They essentially build sub-components.  For example,
    35  * method documentation is a sub-component of class documentation.
    36  *
    37  * This code is not part of an API.
    38  * It is implementation that is subject to change.
    39  * Do not use it as an API
    40  *
    41  * @author Jamie Ho
    42  * @since 1.5
    43  */
    44 public abstract class AbstractMemberBuilder extends AbstractBuilder {
    46     /**
    47      * Construct a SubBuilder.
    48      * @param configuration the configuration used in this run
    49      *        of the doclet.
    50      */
    51     public AbstractMemberBuilder(Configuration configuration) {
    52         super(configuration);
    53     }
    55     /**
    56      * This method is not supported by sub-builders.
    57      *
    58      * @throws DocletAbortException this method will always throw a
    59      * DocletAbortException because it is not supported.
    60      */
    61     public void build() throws DocletAbortException {
    62         //You may not call the build method in a subbuilder.
    63         throw new DocletAbortException();
    64     }
    67     /**
    68      * Build the sub component if there is anything to document.
    69      *
    70      * @param elements {@inheritDoc}
    71      */
    72     public void build(List<?> elements) {
    73         if (hasMembersToDocument()) {
    74             super.build(elements);
    75         }
    76     }
    78     /**
    79      * Return true if this subbuilder has anything to document.
    80      *
    81      * @return true if this subbuilder has anything to document.
    82      */
    83     public abstract boolean hasMembersToDocument();
    84 }

mercurial