jdk.javadoc.internal.doclets.toolkit.builders.AbstractMemberBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.javadoc.internal.doclets.toolkit.builders;
import java.util.List;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind;
/**
* The superclass for all member builders. Member builders are only executed
* within Class Builders. They essentially build sub-components. For example,
* method documentation is a sub-component of class documentation.
*
* This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.
*/
public abstract class AbstractMemberBuilder extends AbstractBuilder {
protected final TypeElement typeElement;
protected final VisibleMemberTable visibleMemberTable;
/**
* Construct a SubBuilder.
* @param context a context object, providing information used in this run
* of the doclet.
*/
public AbstractMemberBuilder(Context context, TypeElement typeElement) {
super(context);
this.typeElement = typeElement;
visibleMemberTable = configuration.getVisibleMemberTable(typeElement);
}
/**
* This method is not supported by sub-builders.
*
* @throws AssertionError always
*/
@Override
public void build() {
// You may not call the build method in a subbuilder.
throw new AssertionError();
}
/**
*
* Build the documentation.
*
* @param contentTree The content tree into which to add the documentation
* @throws DocletException if there is a problem building the documentation
*/
public abstract void build(Content contentTree) throws DocletException;
/**
* Returns true if this subbuilder has anything to document.
*
* @return true if this subbuilder has anything to document
*/
public abstract boolean hasMembersToDocument();
/**
* Returns a list of visible elements of the specified kind in this
* type element.
* @param kind of members
* @return a list of members
*/
protected List getVisibleMembers(Kind kind) {
return visibleMemberTable.getVisibleMembers(kind);
}
}