com.sun.tools.doclets.formats.html
Class WriterFactoryImpl

java.lang.Object
  com.sun.tools.doclets.formats.html.WriterFactoryImpl

All Implemented Interfaces:

WriterFactory

public class WriterFactoryImpl
extends java.lang.Object
implements WriterFactory

The factory that returns HTML writers.

Since:

1.5

Field Summary

private ConfigurationImpl

configuration

Constructor Summary

WriterFactoryImpl(ConfigurationImpl configuration)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configuration

private ConfigurationImpl configuration

Constructor Detail

WriterFactoryImpl

public WriterFactoryImpl(ConfigurationImpl configuration)

Method Detail

getConstantsSummaryWriter

public ConstantsSummaryWriter getConstantsSummaryWriter()
                                                 throws java.lang.Exception

Return the writer for the constant summary.

Specified by:

getConstantsSummaryWriter in interface WriterFactory

Returns:

the writer for the constant summary. Return null if this writer is not supported by the doclet.

Throws:

java.lang.Exception

getPackageSummaryWriter

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

Return the writer for the package summary.

Specified by:

getPackageSummaryWriter in interface WriterFactory

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

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

Return the writer for a class.

Specified by:

getClassWriter in interface WriterFactory

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

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

Return the writer for an annotation type.

Specified by:

getAnnotationTypeWriter in interface WriterFactory

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

getAnnotationTypeOptionalMemberWriter

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

Return the annotation type optional member writer for a given annotation type.

Specified by:

getAnnotationTypeOptionalMemberWriter in interface WriterFactory

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

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

Return the annotation type required member writer for a given annotation type.

Specified by:

getAnnotationTypeRequiredMemberWriter in interface WriterFactory

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

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

Return the enum constant writer for a given class.

Specified by:

getEnumConstantWriter in interface WriterFactory

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

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

Return the field writer for a given class.

Specified by:

getFieldWriter in interface WriterFactory

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

getMethodWriter

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

Return the method writer for a given class.

Specified by:

getMethodWriter in interface WriterFactory

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

getConstructorWriter

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

Return the constructor writer for a given class.

Specified by:

getConstructorWriter in interface WriterFactory

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

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

Return the specified member summary writer for a given class.

Specified by:

getMemberSummaryWriter in interface WriterFactory

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

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

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

Specified by:

getMemberSummaryWriter in interface WriterFactory

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

public SerializedFormWriter getSerializedFormWriter()
                                             throws java.lang.Exception

Return the writer for the serialized form.

Specified by:

getSerializedFormWriter in interface WriterFactory

Returns:

the writer for the serialized form.

Throws:

java.lang.Exception