Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse AbstractMemberBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

Bekannte direkte Unterklassen:

AnnotationTypeMemberBuilder, ConstructorBuilder, EnumConstantBuilder, FieldBuilder, MemberSummaryBuilder, MethodBuilder, PropertyBuilder

public abstract class AbstractMemberBuilder
extends AbstractBuilder

The superclass for all member builders.

Member builders are only executed within Class Builders. They essentially build subcomponents. For example, method documentation is a subcomponent of class documentation.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final TypeElement	typeElement
protected final VisibleMemberTable	visibleMemberTable

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

builderFactory, configuration, containingPackagesSeen, messages, options, resources, utils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractMemberBuilder(AbstractBuilder.Context context, TypeElement typeElement)	Construct a SubBuilder.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	build()	This method is not supported by subbuilders.
abstract void	build(Content target)	Build the documentation.
protected List<Element>	getVisibleMembers(VisibleMemberTable.Kind kind)	Returns a list of visible elements of the specified kind in this type element.
abstract boolean	hasMembersToDocument()	Returns true if this subbuilder has anything to document.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

typeElement

protected final TypeElement typeElement

visibleMemberTable

protected final VisibleMemberTable visibleMemberTable

Konstruktordetails

AbstractMemberBuilder

public AbstractMemberBuilder(AbstractBuilder.Context context,
 TypeElement typeElement)

Construct a SubBuilder.

Parameter:

context - a context object, providing information used in this run of the doclet.

Methodendetails

build

public void build()

This method is not supported by subbuilders.

Angegeben von:

build in Klasse AbstractBuilder

Löst aus:

AssertionError - always

build

public abstract void build(Content target)
                    throws DocletException

Build the documentation.

Parameter:

target - the content into which to add the documentation

Löst aus:

DocletException - if there is a problem building the documentation

hasMembersToDocument

public abstract boolean hasMembersToDocument()

Returns true if this subbuilder has anything to document.

Gibt zurück:

true if this subbuilder has anything to document

getVisibleMembers

protected List<Element> getVisibleMembers(VisibleMemberTable.Kind kind)

Returns a list of visible elements of the specified kind in this type element.

Parameter:

kind - of members

Gibt zurück:

a list of members