Class BuilderFactory
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.BuilderFactory
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Configuration
Deprecated.The current configuration of the doclet.private final AbstractBuilder.Context
Deprecated.private final WriterFactory
Deprecated.The factory to retrieve the required writers from. -
Constructor Summary
ConstructorsConstructorDescriptionBuilderFactory
(Configuration configuration) Deprecated.Construct a builder factory using the given configuration. -
Method Summary
Modifier and TypeMethodDescriptiongetAnnotationTypeBuilder
(AnnotationTypeDoc annotationType, Type prevType, Type nextType) Deprecated.Return the builder for the annotation type.getAnnotationTypeFieldsBuilder
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return an instance of the annotation type fields builder for the given class.getAnnotationTypeOptionalMemberBuilder
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return an instance of the annotation type member builder for the given class.getAnnotationTypeRequiredMemberBuilder
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return an instance of the annotation type member builder for the given class.getClassBuilder
(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) Deprecated.Return the builder for the class.Deprecated.Return the builder that builds the constant summary.getConstructorBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the constructor builder for the given class.getEnumConstantsBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the enum constants builder for the given class.getFieldBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the field builder for the given class.getMemberSummaryBuilder
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return an instance of the member summary builder for the given annotation type.getMemberSummaryBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the member summary builder for the given class.getMethodBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the method builder for the given class.getPackageSummaryBuilder
(PackageDoc pkg, PackageDoc prevPkg, PackageDoc nextPkg) Deprecated.Return the builder that builds the package summary.getPropertyBuilder
(ClassWriter classWriter) Deprecated.Return an instance of the property builder for the given class.Deprecated.Return the builder that builds the serialized form.
-
Field Details
-
configuration
Deprecated.The current configuration of the doclet. -
writerFactory
Deprecated.The factory to retrieve the required writers from. -
context
Deprecated.
-
-
Constructor Details
-
BuilderFactory
Deprecated.Construct a builder factory using the given configuration.- Parameters:
configuration
- the configuration for the current doclet being executed.
-
-
Method Details
-
getConstantsSummaryBuider
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
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
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
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
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
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
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
Deprecated.Return the builder that builds the serialized form.- Returns:
- the builder that builds the serialized form.
- Throws:
Exception
-