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

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.builders.BuilderFactory

public class BuilderFactory
extends java.lang.Object

The factory for constructing builders. 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.4

Field Summary

private Configuration	configuration The current configuration of the doclet.
private WriterFactory	writerFactory The factory to retrieve the required writers from.

Constructor Summary

BuilderFactory(Configuration configuration)
Construct a builder factory using the given configuration.

Method Summary

AbstractBuilder	getAnnotationTypeBuilder(AnnotationTypeDoc annotationType, Type prevType, Type nextType) Return the builder for the annotation type.
AbstractBuilder	getAnnotationTypeOptionalMemberBuilder(AnnotationTypeWriter annotationTypeWriter) Return an instance of the annotation type member builder for the given class.
AbstractBuilder	getAnnotationTypeRequiredMemberBuilder(AnnotationTypeWriter annotationTypeWriter) Return an instance of the annotation type member builder for the given class.
AbstractBuilder	getClassBuilder(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) Return the builder for the class.
AbstractBuilder	getConstantsSummaryBuider() Return the builder that builds the constant summary.
AbstractBuilder	getConstructorBuilder(ClassWriter classWriter) Return an instance of the constructor builder for the given class.
AbstractBuilder	getEnumConstantsBuilder(ClassWriter classWriter) Return an instance of the enum constants builder for the given class.
AbstractBuilder	getFieldBuilder(ClassWriter classWriter) Return an instance of the field builder for the given class.
AbstractBuilder	getMemberSummaryBuilder(AnnotationTypeWriter annotationTypeWriter) Return an instance of the member summary builder for the given annotation type.
AbstractBuilder	getMemberSummaryBuilder(ClassWriter classWriter) Return an instance of the member summary builder for the given class.
AbstractBuilder	getMethodBuilder(ClassWriter classWriter) Return an instance of the method builder for the given class.
AbstractBuilder	getPackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg, PackageDoc nextPkg) Return the builder that builds the package summary.
AbstractBuilder	getSerializedFormBuilder() Return the builder that builds the serialized form.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

private Configuration configuration

The current configuration of the doclet.

writerFactory

private WriterFactory writerFactory

The factory to retrieve the required writers from.

Constructor Detail

BuilderFactory

public BuilderFactory(Configuration configuration)

Construct a builder factory using the given configuration.

Parameters:

configuration - the configuration for the current doclet being executed.

Method Detail

getConstantsSummaryBuider

public AbstractBuilder getConstantsSummaryBuider()
                                          throws java.lang.Exception

Return the builder that builds the constant summary.

Returns:

the builder that builds the constant summary.

Throws:

java.lang.Exception

getPackageSummaryBuilder

public AbstractBuilder getPackageSummaryBuilder(PackageDoc pkg,
                                                PackageDoc prevPkg,
                                                PackageDoc nextPkg)
                                         throws java.lang.Exception

Return the builder that builds the package summary.

Parameters:

pkg - the package being documented.

prevPkg - the previous package being documented.

nextPkg - the next package being documented.

Returns:

the builder that builds the constant summary.

Throws:

java.lang.Exception

getClassBuilder

public AbstractBuilder getClassBuilder(ClassDoc classDoc,
                                       ClassDoc prevClass,
                                       ClassDoc nextClass,
                                       ClassTree classTree)
                                throws java.lang.Exception

Return the builder for the class.

Parameters:

classDoc - the class being documented.

prevClass - the previous class that was documented.

nextClass - the next class being documented.

classTree - the class tree.

Returns:

the writer for the class. Return null if this writer is not supported by the doclet.

Throws:

java.lang.Exception

getAnnotationTypeBuilder

public AbstractBuilder getAnnotationTypeBuilder(AnnotationTypeDoc annotationType,
                                                Type prevType,
                                                Type nextType)
                                         throws java.lang.Exception

Return the builder for the annotation type.

Parameters:

annotationType - the annotation type being documented.

prevType - the previous type that was documented.

nextType - the next type being documented.

Returns:

the writer for the annotation type. Return null if this writer is not supported by the doclet.

Throws:

java.lang.Exception

getMethodBuilder

public AbstractBuilder getMethodBuilder(ClassWriter classWriter)
                                 throws java.lang.Exception

Return an instance of the method builder for the given class.

Returns:

an instance of the method builder for the given class.

Throws:

java.lang.Exception

getAnnotationTypeOptionalMemberBuilder

public AbstractBuilder getAnnotationTypeOptionalMemberBuilder(AnnotationTypeWriter annotationTypeWriter)
                                                       throws java.lang.Exception

Return an instance of the annotation type member builder for the given class.

Returns:

an instance of the annotation type memebr builder for the given annotation type.

Throws:

java.lang.Exception

getAnnotationTypeRequiredMemberBuilder

public AbstractBuilder getAnnotationTypeRequiredMemberBuilder(AnnotationTypeWriter annotationTypeWriter)
                                                       throws java.lang.Exception

Return an instance of the annotation type member builder for the given class.

Returns:

an instance of the annotation type memebr builder for the given annotation type.

Throws:

java.lang.Exception

getEnumConstantsBuilder

public AbstractBuilder getEnumConstantsBuilder(ClassWriter classWriter)
                                        throws java.lang.Exception

Return an instance of the enum constants builder for the given class.

Returns:

an instance of the enum constants builder for the given class.

Throws:

java.lang.Exception

getFieldBuilder

public AbstractBuilder getFieldBuilder(ClassWriter classWriter)
                                throws java.lang.Exception

Return an instance of the field builder for the given class.

Returns:

an instance of the field builder for the given class.

Throws:

java.lang.Exception

getConstructorBuilder

public AbstractBuilder getConstructorBuilder(ClassWriter classWriter)
                                      throws java.lang.Exception

Return an instance of the constructor builder for the given class.

Returns:

an instance of the constructor builder for the given class.

Throws:

java.lang.Exception

getMemberSummaryBuilder

public AbstractBuilder getMemberSummaryBuilder(ClassWriter classWriter)
                                        throws java.lang.Exception

Return an instance of the member summary builder for the given class.

Returns:

an instance of the member summary builder for the given class.

Throws:

java.lang.Exception

getMemberSummaryBuilder

public AbstractBuilder getMemberSummaryBuilder(AnnotationTypeWriter annotationTypeWriter)
                                        throws java.lang.Exception

Return an instance of the member summary builder for the given annotation type.

Returns:

an instance of the member summary builder for the given annotation type.

Throws:

java.lang.Exception

getSerializedFormBuilder

public AbstractBuilder getSerializedFormBuilder()
                                         throws java.lang.Exception

Return the builder that builds the serialized form.

Returns:

the builder that builds the serialized form.

Throws:

java.lang.Exception