com.sun.tools.doclets.internal.toolkit.builders
Class AbstractMemberBuilder

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
      com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder

Direct Known Subclasses:

AnnotationTypeRequiredMemberBuilder, ConstructorBuilder, EnumConstantBuilder, FieldBuilder, MemberSummaryBuilder, MethodBuilder

public abstract class AbstractMemberBuilder
extends AbstractBuilder

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 code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Field Summary

Fields inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

configuration, containingPackagesSeen, DEBUG

Constructor Summary

AbstractMemberBuilder(Configuration configuration)
Construct a SubBuilder.

Method Summary

void	build() This method is not supported by sub-builders.
void	build(java.util.List<?> elements) Build the sub component if there is anything to document.
abstract boolean	hasMembersToDocument() Return true if this subbuilder has anything to document.

Methods inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

getName, invokeMethod

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMemberBuilder

public AbstractMemberBuilder(Configuration configuration)

Construct a SubBuilder.

Parameters:

configuration - the configuration used in this run of the doclet.

Method Detail

build

public void build()
           throws DocletAbortException

This method is not supported by sub-builders.

Specified by:

build in class AbstractBuilder

Throws:

DocletAbortException - this method will always throw a DocletAbortException because it is not supported.

build

public void build(java.util.List<?> elements)

Build the sub component if there is anything to document.

Overrides:

build in class AbstractBuilder

Parameters:

elements - the XML elements that specify which components to document.

hasMembersToDocument

public abstract boolean hasMembersToDocument()

Return true if this subbuilder has anything to document.

Returns:

true if this subbuilder has anything to document.