Interface WriterFactory
- All Known Implementing Classes:
WriterFactoryImpl
Deprecated.
The interface for a factory creates writers.
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
-
Method Summary
Modifier and TypeMethodDescriptiongetAnnotationTypeFieldWriter
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return the annotation type field writer for a given annotation type.getAnnotationTypeOptionalMemberWriter
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return the annotation type optional member writer for a given annotation type.getAnnotationTypeRequiredMemberWriter
(AnnotationTypeWriter annotationTypeWriter) Deprecated.Return the annotation type required member writer for a given annotation type.getAnnotationTypeWriter
(AnnotationTypeDoc annotationType, Type prevType, Type nextType) Deprecated.Return the writer for an annotation type.getClassWriter
(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) Deprecated.Return the writer for a class.Deprecated.Return the writer for the constant summary.getConstructorWriter
(ClassWriter classWriter) Deprecated.Return the constructor writer for a given class.getEnumConstantWriter
(ClassWriter classWriter) Deprecated.Return the enum constant writer for a given class.getFieldWriter
(ClassWriter classWriter) Deprecated.Return the field writer for a given class.getMemberSummaryWriter
(AnnotationTypeWriter annotationTypeWriter, int memberType) Deprecated.Return the specified member summary writer for a given annotation type.getMemberSummaryWriter
(ClassWriter classWriter, int memberType) Deprecated.Return the specified member summary writer for a given class.getMethodWriter
(ClassWriter classWriter) Deprecated.Return the method writer for a given class.getPackageSummaryWriter
(PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) Deprecated.Return the writer for the package summary.getPropertyWriter
(ClassWriter classWriter) Deprecated.Return the property writer for a given class.Deprecated.Return the writer for the serialized form.
-
Method Details
-
getConstantsSummaryWriter
Deprecated.Return the writer for the constant summary.- Returns:
- the writer for the constant summary. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getPackageSummaryWriter
PackageSummaryWriter getPackageSummaryWriter(PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) throws Exception Deprecated.Return the writer for the package summary.- Parameters:
packageDoc
- the package being documented.prevPkg
- the previous package that was documented.nextPkg
- the next package being documented.- Returns:
- the writer for the package summary. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getClassWriter
ClassWriter getClassWriter(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) throws Exception Deprecated.Return the writer for a 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
-
getAnnotationTypeWriter
AnnotationTypeWriter getAnnotationTypeWriter(AnnotationTypeDoc annotationType, Type prevType, Type nextType) throws Exception Deprecated.Return the writer for an annotation type.- Parameters:
annotationType
- the 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
-
getMethodWriter
Deprecated.Return the method writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.- Returns:
- the method writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getAnnotationTypeFieldWriter
AnnotationTypeFieldWriter getAnnotationTypeFieldWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception Deprecated.Return the annotation type field writer for a given annotation type.- Parameters:
annotationTypeWriter
- the writer for the annotation type being documented.- Returns:
- the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getAnnotationTypeOptionalMemberWriter
AnnotationTypeOptionalMemberWriter getAnnotationTypeOptionalMemberWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception Deprecated.Return the annotation type optional member writer for a given annotation type.- Parameters:
annotationTypeWriter
- the writer for the annotation type being documented.- Returns:
- the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getAnnotationTypeRequiredMemberWriter
AnnotationTypeRequiredMemberWriter getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter) throws Exception Deprecated.Return the annotation type required member writer for a given annotation type.- Parameters:
annotationTypeWriter
- the writer for the annotation type being documented.- Returns:
- the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getEnumConstantWriter
Deprecated.Return the enum constant writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.- Returns:
- the enum constant writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getFieldWriter
Deprecated.Return the field writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.- Returns:
- the field writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getPropertyWriter
Deprecated.Return the property writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.- Returns:
- the property writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getConstructorWriter
Deprecated.Return the constructor writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.- Returns:
- the method writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
Exception
-
getMemberSummaryWriter
MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter, int memberType) throws Exception Deprecated.Return the specified member summary writer for a given class.- Parameters:
classWriter
- the writer for the class being documented.memberType
- theVisibleMemberMap
member type indicating the type of member summary that should be returned.- Returns:
- the summary writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
IllegalArgumentException
- if memberType is unknown.Exception
- See Also:
-
getMemberSummaryWriter
MemberSummaryWriter getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter, int memberType) throws Exception Deprecated.Return the specified member summary writer for a given annotation type.- Parameters:
annotationTypeWriter
- the writer for the annotation type being documented.memberType
- theVisibleMemberMap
member type indicating the type of member summary that should be returned.- Returns:
- the summary writer for the give class. Return null if this writer is not supported by the doclet.
- Throws:
IllegalArgumentException
- if memberType is unknown.Exception
- See Also:
-
getSerializedFormWriter
Deprecated.Return the writer for the serialized form.- Returns:
- the writer for the serialized form.
- Throws:
Exception
-