com.sun.tools.doclets.internal.toolkit
Interface WriterFactory

All Known Implementing Classes:

WriterFactoryImpl

public interface WriterFactory

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

Since:

1.4

Method Summary

AnnotationTypeOptionalMemberWriter	getAnnotationTypeOptionalMemberWriter(AnnotationTypeWriter annotationTypeWriter) Return the annotation type optional member writer for a given annotation type.
AnnotationTypeRequiredMemberWriter	getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter) Return the annotation type required member writer for a given annotation type.
AnnotationTypeWriter	getAnnotationTypeWriter(AnnotationTypeDoc annotationType, Type prevType, Type nextType) Return the writer for an annotation type.
ClassWriter	getClassWriter(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree) Return the writer for a class.
ConstantsSummaryWriter	getConstantsSummaryWriter() Return the writer for the constant summary.
ConstructorWriter	getConstructorWriter(ClassWriter classWriter) Return the constructor writer for a given class.
EnumConstantWriter	getEnumConstantWriter(ClassWriter classWriter) Return the enum constant writer for a given class.
FieldWriter	getFieldWriter(ClassWriter classWriter) Return the field writer for a given class.
MemberSummaryWriter	getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter, int memberType) Return the specified member summary writer for a given annotation type.
MemberSummaryWriter	getMemberSummaryWriter(ClassWriter classWriter, int memberType) Return the specified member summary writer for a given class.
MethodWriter	getMethodWriter(ClassWriter classWriter) Return the method writer for a given class.
PackageSummaryWriter	getPackageSummaryWriter(PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg) Return the writer for the package summary.
SerializedFormWriter	getSerializedFormWriter() Return the writer for the serialized form.

Method Detail

getConstantsSummaryWriter

ConstantsSummaryWriter getConstantsSummaryWriter()
                                                 throws java.lang.Exception

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:

java.lang.Exception

getPackageSummaryWriter

PackageSummaryWriter getPackageSummaryWriter(PackageDoc packageDoc,
                                             PackageDoc prevPkg,
                                             PackageDoc nextPkg)
                                             throws java.lang.Exception

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:

java.lang.Exception

getClassWriter

ClassWriter getClassWriter(ClassDoc classDoc,
                           ClassDoc prevClass,
                           ClassDoc nextClass,
                           ClassTree classTree)
                           throws java.lang.Exception

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:

java.lang.Exception

getAnnotationTypeWriter

AnnotationTypeWriter getAnnotationTypeWriter(AnnotationTypeDoc annotationType,
                                             Type prevType,
                                             Type nextType)
                                             throws java.lang.Exception

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:

java.lang.Exception

getMethodWriter

MethodWriter getMethodWriter(ClassWriter classWriter)
                             throws java.lang.Exception

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:

java.lang.Exception

getAnnotationTypeOptionalMemberWriter

AnnotationTypeOptionalMemberWriter getAnnotationTypeOptionalMemberWriter(AnnotationTypeWriter annotationTypeWriter)
                                                                         throws java.lang.Exception

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:

java.lang.Exception

getAnnotationTypeRequiredMemberWriter

AnnotationTypeRequiredMemberWriter getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter)
                                                                         throws java.lang.Exception

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:

java.lang.Exception

getEnumConstantWriter

EnumConstantWriter getEnumConstantWriter(ClassWriter classWriter)
                                         throws java.lang.Exception

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:

java.lang.Exception

getFieldWriter

FieldWriter getFieldWriter(ClassWriter classWriter)
                           throws java.lang.Exception

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:

java.lang.Exception

getConstructorWriter

ConstructorWriter getConstructorWriter(ClassWriter classWriter)
                                       throws java.lang.Exception

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:

java.lang.Exception

getMemberSummaryWriter

MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter,
                                           int memberType)
                                           throws java.lang.Exception

Return the specified member summary writer for a given class.

Parameters:

classWriter - the writer for the class being documented.

memberType - the VisibleMemberMap 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:

java.lang.IllegalArgumentException - if memberType is unknown.

java.lang.Exception

See Also:

VisibleMemberMap

getMemberSummaryWriter

MemberSummaryWriter getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter,
                                           int memberType)
                                           throws java.lang.Exception

Return the specified member summary writer for a given annotation type.

Parameters:

annotationTypeWriter - the writer for the annotation type being documented.

memberType - the VisibleMemberMap 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:

java.lang.IllegalArgumentException - if memberType is unknown.

java.lang.Exception

See Also:

VisibleMemberMap

getSerializedFormWriter

SerializedFormWriter getSerializedFormWriter()
                                             throws java.lang.Exception

Return the writer for the serialized form.

Returns:

the writer for the serialized form.

Throws:

java.lang.Exception