Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class WriterFactoryImpl

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.formats.html.WriterFactoryImpl

All Implemented Interfaces:

WriterFactory

@Deprecated
public class WriterFactoryImpl
extends java.lang.Object
implements WriterFactory

Deprecated.

The factory that returns HTML 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.5

Field Summary

Fields

Modifier and Type	Field	Description
private ConfigurationImpl	configuration	Deprecated.

Constructor Summary

Constructors

Constructor	Description
WriterFactoryImpl(ConfigurationImpl configuration)	Deprecated.

Method Summary

Modifier and Type	Method	Description
AnnotationTypeFieldWriter	getAnnotationTypeFieldWriter(AnnotationTypeWriter annotationTypeWriter)	Deprecated. Return the annotation type field writer for a given annotation type.
AnnotationTypeOptionalMemberWriter	getAnnotationTypeOptionalMemberWriter(AnnotationTypeWriter annotationTypeWriter)	Deprecated. Return the annotation type optional member writer for a given annotation type.
AnnotationTypeRequiredMemberWriter	getAnnotationTypeRequiredMemberWriter(AnnotationTypeWriter annotationTypeWriter)	Deprecated. Return the annotation type required member writer for a given annotation type.
AnnotationTypeWriter	getAnnotationTypeWriter(AnnotationTypeDoc annotationType, Type prevType, Type nextType)	Deprecated. Return the writer for an annotation type.
ClassWriter	getClassWriter(ClassDoc classDoc, ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)	Deprecated. Return the writer for a class.
ConstantsSummaryWriter	getConstantsSummaryWriter()	Deprecated. Return the writer for the constant summary.
ConstructorWriterImpl	getConstructorWriter(ClassWriter classWriter)	Deprecated. Return the constructor writer for a given class.
EnumConstantWriterImpl	getEnumConstantWriter(ClassWriter classWriter)	Deprecated. Return the enum constant writer for a given class.
FieldWriterImpl	getFieldWriter(ClassWriter classWriter)	Deprecated. Return the field writer for a given class.
MemberSummaryWriter	getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter, int memberType)	Deprecated. Return the specified member summary writer for a given annotation type.
MemberSummaryWriter	getMemberSummaryWriter(ClassWriter classWriter, int memberType)	Deprecated. Return the specified member summary writer for a given class.
MethodWriterImpl	getMethodWriter(ClassWriter classWriter)	Deprecated. Return the method writer for a given class.
PackageSummaryWriter	getPackageSummaryWriter(PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg)	Deprecated. Return the writer for the package summary.
PropertyWriterImpl	getPropertyWriter(ClassWriter classWriter)	Deprecated. Return the property writer for a given class.
SerializedFormWriter	getSerializedFormWriter()	Deprecated. 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 final ConfigurationImpl configuration

Deprecated.

Constructor Detail

WriterFactoryImpl

public WriterFactoryImpl(ConfigurationImpl configuration)

Deprecated.

Method Detail

getConstantsSummaryWriter

public ConstantsSummaryWriter getConstantsSummaryWriter()
                                                 throws java.lang.Exception

Deprecated.

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

Deprecated.

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.io.IOException

Deprecated.

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.io.IOException

getAnnotationTypeWriter

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

Deprecated.

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

getAnnotationTypeFieldWriter

public AnnotationTypeFieldWriter getAnnotationTypeFieldWriter(AnnotationTypeWriter annotationTypeWriter)
                                                       throws java.lang.Exception

Deprecated.

Return the annotation type field writer for a given annotation type.

Specified by:

getAnnotationTypeFieldWriter 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

getAnnotationTypeOptionalMemberWriter

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

Deprecated.

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

Deprecated.

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 EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter)
                                             throws java.lang.Exception

Deprecated.

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 FieldWriterImpl getFieldWriter(ClassWriter classWriter)
                               throws java.lang.Exception

Deprecated.

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

getPropertyWriter

public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter)
                                     throws java.lang.Exception

Deprecated.

Return the property writer for a given class.

Specified by:

getPropertyWriter in interface WriterFactory

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:

java.lang.Exception

getMethodWriter

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

Deprecated.

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 ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter)
                                           throws java.lang.Exception

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

Return the writer for the serialized form.

Specified by:

getSerializedFormWriter in interface WriterFactory

Returns:

the writer for the serialized form.

Throws:

java.lang.Exception