Class BuilderFactory
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.BuilderFactory
-
@Deprecated public class BuilderFactory extends Object
Deprecated.The factory for constructing builders.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.
- Since:
- 1.4
- Author:
- Jamie Ho
-
-
Constructor Summary
Constructors Constructor Description BuilderFactory(Configuration configuration)
Deprecated.Construct a builder factory using the given configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AbstractBuilder
getAnnotationTypeBuilder(AnnotationTypeDoc annotationType, Type prevType, Type nextType)
Deprecated.Return the builder for the annotation type.AbstractBuilder
getAnnotationTypeFieldsBuilder(AnnotationTypeWriter annotationTypeWriter)
Deprecated.Return an instance of the annotation type fields builder for the given class.AbstractBuilder
getAnnotationTypeOptionalMemberBuilder(AnnotationTypeWriter annotationTypeWriter)
Deprecated.Return an instance of the annotation type member builder for the given class.AbstractBuilder
getAnnotationTypeRequiredMemberBuilder(AnnotationTypeWriter annotationTypeWriter)
Deprecated.Return an instance of the annotation type member builder for the given class.AbstractBuilder
getClassBuilder(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)
Deprecated.Return the builder for the class.AbstractBuilder
getConstantsSummaryBuider()
Deprecated.Return the builder that builds the constant summary.AbstractBuilder
getConstructorBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the constructor builder for the given class.AbstractBuilder
getEnumConstantsBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the enum constants builder for the given class.AbstractBuilder
getFieldBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the field builder for the given class.AbstractBuilder
getMemberSummaryBuilder(AnnotationTypeWriter annotationTypeWriter)
Deprecated.Return an instance of the member summary builder for the given annotation type.AbstractBuilder
getMemberSummaryBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the member summary builder for the given class.AbstractBuilder
getMethodBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the method builder for the given class.AbstractBuilder
getPackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg, PackageDoc nextPkg)
Deprecated.Return the builder that builds the package summary.AbstractBuilder
getPropertyBuilder(ClassWriter classWriter)
Deprecated.Return an instance of the property builder for the given class.AbstractBuilder
getSerializedFormBuilder()
Deprecated.Return the builder that builds the serialized form.
-
-
-
Constructor Detail
-
BuilderFactory
public BuilderFactory(Configuration configuration)
Deprecated.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 Exception
Deprecated.Return the builder that builds the constant summary.- Returns:
- the builder that builds the constant summary.
- Throws:
Exception
-
getPackageSummaryBuilder
public AbstractBuilder getPackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg, PackageDoc nextPkg) throws Exception
Deprecated.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:
Exception
-
getClassBuilder
public AbstractBuilder getClassBuilder(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) throws Exception
Deprecated.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:
Exception
-
getAnnotationTypeBuilder
public AbstractBuilder getAnnotationTypeBuilder(AnnotationTypeDoc annotationType, Type prevType, Type nextType) throws Exception
Deprecated.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:
Exception
-
getMethodBuilder
public AbstractBuilder getMethodBuilder(ClassWriter classWriter) throws Exception
Deprecated.Return an instance of the method builder for the given class.- Returns:
- an instance of the method builder for the given class.
- Throws:
Exception
-
getAnnotationTypeFieldsBuilder
public AbstractBuilder getAnnotationTypeFieldsBuilder(AnnotationTypeWriter annotationTypeWriter) throws Exception
Deprecated.Return an instance of the annotation type fields builder for the given class.- Returns:
- an instance of the annotation type field builder for the given annotation type.
- Throws:
Exception
-
getAnnotationTypeOptionalMemberBuilder
public AbstractBuilder getAnnotationTypeOptionalMemberBuilder(AnnotationTypeWriter annotationTypeWriter) throws Exception
Deprecated.Return an instance of the annotation type member builder for the given class.- Returns:
- an instance of the annotation type member builder for the given annotation type.
- Throws:
Exception
-
getAnnotationTypeRequiredMemberBuilder
public AbstractBuilder getAnnotationTypeRequiredMemberBuilder(AnnotationTypeWriter annotationTypeWriter) throws Exception
Deprecated.Return an instance of the annotation type member builder for the given class.- Returns:
- an instance of the annotation type member builder for the given annotation type.
- Throws:
Exception
-
getEnumConstantsBuilder
public AbstractBuilder getEnumConstantsBuilder(ClassWriter classWriter) throws Exception
Deprecated.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:
Exception
-
getFieldBuilder
public AbstractBuilder getFieldBuilder(ClassWriter classWriter) throws Exception
Deprecated.Return an instance of the field builder for the given class.- Returns:
- an instance of the field builder for the given class.
- Throws:
Exception
-
getPropertyBuilder
public AbstractBuilder getPropertyBuilder(ClassWriter classWriter) throws Exception
Deprecated.Return an instance of the property builder for the given class.- Returns:
- an instance of the field builder for the given class.
- Throws:
Exception
-
getConstructorBuilder
public AbstractBuilder getConstructorBuilder(ClassWriter classWriter) throws Exception
Deprecated.Return an instance of the constructor builder for the given class.- Returns:
- an instance of the constructor builder for the given class.
- Throws:
Exception
-
getMemberSummaryBuilder
public AbstractBuilder getMemberSummaryBuilder(ClassWriter classWriter) throws Exception
Deprecated.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:
Exception
-
getMemberSummaryBuilder
public AbstractBuilder getMemberSummaryBuilder(AnnotationTypeWriter annotationTypeWriter) throws Exception
Deprecated.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:
Exception
-
getSerializedFormBuilder
public AbstractBuilder getSerializedFormBuilder() throws Exception
Deprecated.Return the builder that builds the serialized form.- Returns:
- the builder that builds the serialized form.
- Throws:
Exception
-
-