The interface for a factory creates writers.
This code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
author: Jamie Ho since: 1.4
getAnnotationTypeOptionalMemberWriter(AnnotationTypeWriter annotationTypeWriter) Return the annotation type optional member writer for a given annotation
type.
Parameters: annotationTypeWriter - the writer for the annotation typebeing documented.
getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter) Return the annotation type required member writer for a given annotation type.
Parameters: annotationTypeWriter - the writer for the annotation typebeing documented.
getAnnotationTypeWriter(AnnotationTypeDoc annotationType, Type prevType, Type nextType) Return the writer for an annotation type.
Parameters: annotationType - the type being documented. Parameters: prevType - the previous type that was documented. Parameters: nextType - the next type being documented.
getClassWriter(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) Return the writer for a class.
Parameters: classDoc - the class being documented. Parameters: prevClass - the previous class that was documented. Parameters: nextClass - the next class being documented. Parameters: classTree - the class tree.
getConstructorWriter(ClassWriter classWriter) Return the constructor writer for a given class.
Parameters: classWriter - the writer for the class being documented.
getEnumConstantWriter(ClassWriter classWriter) Return the enum constant writer for a given class.
Parameters: classWriter - the writer for the class being documented.
getFieldWriter(ClassWriter classWriter) Return the field writer for a given class.
Parameters: classWriter - the writer for the class being documented.
getMemberSummaryWriter(ClassWriter classWriter, int memberType) Return the specified member summary writer for a given class.
Parameters: classWriter - the writer for the class being documented. Parameters: memberType - the VisibleMemberMap member type indicatingthe type of member summary that should be returned.
getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter, int memberType) Return the specified member summary writer for a given annotation type.
Parameters: annotationTypeWriter - the writer for the annotation type being documented. Parameters: memberType - the VisibleMemberMap member type indicatingthe type of member summary that should be returned.
getMethodWriter(ClassWriter classWriter) Return the method writer for a given class.
Parameters: classWriter - the writer for the class being documented.
getPackageSummaryWriter(PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) Return the writer for the package summary.
Parameters: packageDoc - the package being documented. Parameters: prevPkg - the previous package that was documented. Parameters: nextPkg - the next package being documented.
Return the annotation type optional member writer for a given annotation
type.
Parameters: annotationTypeWriter - the writer for the annotation typebeing documented. the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
Return the annotation type required member writer for a given annotation type.
Parameters: annotationTypeWriter - the writer for the annotation typebeing documented. the member writer for the given annotation type. Return null if this writer is not supported by the doclet.
getAnnotationTypeWriter
abstractpublicAnnotationTypeWriter getAnnotationTypeWriter(AnnotationTypeDoc annotationType, Type prevType, Type nextType) throws Exception(Code)
Return the writer for an annotation type.
Parameters: annotationType - the type being documented. Parameters: prevType - the previous type that was documented. Parameters: nextType - the next type being documented. the writer for the annotation type. Return null if thiswriter is not supported by the doclet.
Return the writer for a class.
Parameters: classDoc - the class being documented. Parameters: prevClass - the previous class that was documented. Parameters: nextClass - the next class being documented. Parameters: classTree - the class tree. the writer for the class. Return null if thiswriter is not supported by the doclet.
Return the constructor writer for a given class.
Parameters: classWriter - the writer for the class being documented. the method writer for the give class. Return null if thiswriter is not supported by the doclet.
Return the enum constant writer for a given class.
Parameters: classWriter - the writer for the class being documented. the enum constant writer for the give class. Return null if thiswriter is not supported by the doclet.
Return the field writer for a given class.
Parameters: classWriter - the writer for the class being documented. the field writer for the give class. Return null if thiswriter is not supported by the doclet.
Return the specified member summary writer for a given class.
Parameters: classWriter - the writer for the class being documented. Parameters: memberType - the VisibleMemberMap member type indicatingthe type of member summary that should be returned. the summary writer for the give class. Return null if thiswriter is not supported by the doclet. See Also:VisibleMemberMap throws: IllegalArgumentException - if memberType is unknown.
Return the specified member summary writer for a given annotation type.
Parameters: annotationTypeWriter - the writer for the annotation type being documented. Parameters: memberType - the VisibleMemberMap member type indicatingthe type of member summary that should be returned. the summary writer for the give class. Return null if thiswriter is not supported by the doclet. See Also:VisibleMemberMap throws: IllegalArgumentException - if memberType is unknown.
Return the method writer for a given class.
Parameters: classWriter - the writer for the class being documented. the method writer for the give class. Return null if thiswriter is not supported by the doclet.
Return the writer for the package summary.
Parameters: packageDoc - the package being documented. Parameters: prevPkg - the previous package that was documented. Parameters: nextPkg - the next package being documented. the writer for the package summary. Return null if thiswriter is not supported by the doclet.